Boundary Controller HTTP API
User Service
Lists all Users.
Request
Query Parameters
scope_id
string
recursive
boolean
filter
string
Response
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[]
Creates a single User.
Request
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.
Response
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[]
Gets a single User.
Request
Path Parameters
id
string
RequiredResponse
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[]
Deletes a User.
Request
Path Parameters
id
string
RequiredResponse
Successful Response
Updates a User.
Request
Path Parameters
id
string
RequiredQuery Parameters
update_mask
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.
Response
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[]
Associates an Account to a User.
Request
Path Parameters
id
string
RequiredBody Parameters
id
string
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[]
Response
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[]
Removes the specified Accounts from being associated with the provided User.
Request
Path Parameters
id
string
RequiredBody Parameters
id
string
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[]
Response
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[]
Set the Accounts associated to the User to exactly the list of provided in the request, removing any Accounts that are not specified.
Request
Path Parameters
id
string
RequiredBody Parameters
id
string
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[]
Response
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[]