Just announced HashiConf Global full schedule: keynotes, sessions, labs & more. Register Now

A new platform for documentation and tutorials is launching soon.

We are migrating Boundary documentation into HashiCorp Developer, our new developer experience.

Join Now

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

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

Gets a single User.

Request

Path Parameters

id string Required

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

Deletes a User.

Request

Path Parameters

id string Required

Response

Successful Response

No content.

Updates a User.

Request

Path Parameters

id string Required

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

Associates an Account to a User.

Request

Path Parameters

id string Required

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

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

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

Request

Path Parameters

id string Required

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

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

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

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