Boundary Controller HTTP API
Account Service
Lists all Accounts in a specific Auth Method.
Request
Query Parameters
auth_method_id
string
filter
string
Response
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.
authorized_actions
string[]
Creates a single Account in the provided Auth Method.
Request
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.
Response
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.
authorized_actions
string[]
Gets a single Account.
Request
Path Parameters
id
string
RequiredResponse
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.
authorized_actions
string[]
Deletes an Account.
Request
Path Parameters
id
string
RequiredResponse
Successful Response
Updates an Account.
Request
Path Parameters
id
string
RequiredQuery Parameters
update_mask
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.
Response
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.
authorized_actions
string[]
Sets the password for the provided Account.
Request
Path Parameters
id
string
RequiredBody Parameters
id
string
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
Response
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.
authorized_actions
string[]
Sets the password for the provided Account.
Request
Path Parameters
id
string
RequiredBody Parameters
id
string
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
Response
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.
authorized_actions
string[]