Boundary controller HTTP API

Account Service

List AccountsGET/v1/accounts

Lists all Accounts in a specific Auth Method.

Query Parameters

auth_method_id string

filter string

list_token string

An opaque token used to continue an existing iteration or request updated items. If not specified, pagination will start from the beginning.

page_size integer

The maximum size of a page in this iteration. If unset, the default page size configured will be used. If the page_size is greater than the default page configured, an error will be returned.

Successful Response

items object[]

Account contains all fields related to an Account resource

id string

Output only. The ID of the Account.

scope object

Output only. Scope information for the Account.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

managed_group_ids string[]

authorized_actions string[]

response_type string

The type of response, either "delta" or "complete". Delta signifies that this is part of a paginated result or an update to a previously completed pagination. Complete signifies that it is the last page.

list_token string

An opaque token used to continue an existing pagination or request updated items. Use this token in the next list request to request the next page.

sort_by string

The name of the field which the items are sorted by.

sort_dir string

The direction of the sort, either "asc" or "desc".

removed_ids string[]

est_item_count integer

An estimate at the total items available. This may change during pagination.

Create AccountPOST/v1/accounts

Creates a single Account in the provided Auth Method.

Body Parameters

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

Successful Response

id string

Output only. The ID of the Account.

scope object

Output only. Scope information for the Account.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

managed_group_ids string[]

authorized_actions string[]

Get AccountGET/v1/accounts/{id}

Gets a single Account based on the input id

Path Parameters

id string

Successful Response

id string

Output only. The ID of the Account.

scope object

Output only. Scope information for the Account.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

managed_group_ids string[]

authorized_actions string[]

Delete AccountDELETE/v1/accounts/{id}

Deletes an Account.

Path Parameters

id string

Update AccountPATCH/v1/accounts/{id}

Updates an Account.

Path Parameters

id string

Body Parameters

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

Successful Response

id string

Output only. The ID of the Account.

scope object

Output only. Scope information for the Account.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

managed_group_ids string[]

authorized_actions string[]

Change PasswordPOST/v1/accounts/{id}:change-password

Sets the password for the provided Account.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

current_password string

new_password string

Successful Response

id string

Output only. The ID of the Account.

scope object

Output only. Scope information for the Account.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

managed_group_ids string[]

authorized_actions string[]

Set PasswordPOST/v1/accounts/{id}:set-password

Sets the password for the provided Account.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

password string

Successful Response

id string

Output only. The ID of the Account.

scope object

Output only. Scope information for the Account.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this Account.

auth_method_id string

The ID of the Auth Method that is associated with this Account.

attributes object

The attributes that are applicable for the specific Account type.

managed_group_ids string[]

authorized_actions string[]