Boundary Controller HTTP API

User Service

List UsersGET/v1/users

Lists all Users.

Query Parameters

scope_id string

recursive boolean

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[]

User contains all fields related to a User resource

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method

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 UserPOST/v1/users

Creates a single User.

Body Parameters

scope_id string

The ID of the Scope this resource is in.

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.

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method

Get UserGET/v1/users/{id}

Gets a single User.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method

Delete UserDELETE/v1/users/{id}

Deletes a User.

Path Parameters

id string

Update UserPATCH/v1/users/{id}

Updates a User.

Path Parameters

id string

Body Parameters

scope_id string

The ID of the Scope this resource is in.

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.

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method

Add User AccountsPOST/v1/users/{id}:add-accounts

Associates an Account to a User.

Path Parameters

id string

Body Parameters

version integer

The version ensures the User hasn't changed since it was last retrieved and if it has the request will fail.

account_ids string[]

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method

Remove User AccountsPOST/v1/users/{id}:remove-accounts

Removes the specified Accounts from being associated with the provided User.

Path Parameters

id string

Body Parameters

version integer

The version ensures the User hasn't changed since it was last retrieved and if it has the request will fail.

account_ids string[]

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method

Set User AccountsPOST/v1/users/{id}:set-accounts

Set the Accounts associated to the User to exactly the list of provided in the request, removing any Accounts that are not specified.

Path Parameters

id string

Body Parameters

version integer

The version ensures the User hasn't changed since it was last retrieved and if it has the request will fail.

account_ids string[]

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.

scope object

Output only. Scope information for this resource.

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.

account_ids string[]

accounts object[]

id string

Output only. The ID of the Account.

scope_id string

Output only. The Scope containing the Account.

authorized_actions string[]

login_name string

Output only. login_name is a string that maps to the user's account "login name" from the scope's primary auth method

full_name string

Output only. full_name is a string that maps to the user's account name from the scope's primary auth method

email string

Output only. email is a string that maps to the user's account email from the scope's primary auth method

primary_account_id string

Output only. primary_account_id is a string that maps to the user's account public_id from the scope's primary auth method