• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Boundary
  • Install
  • Tutorials
  • Documentation
  • API
  • Try Cloud(opens in new tab)
  • Sign up
Boundary Home

API

Skip to main content
  • API

  • Account Service
  • Auth Method Service
  • Auth Token Service
  • Credential Library Service
  • Credential Service
  • Credential Store Service
  • Group Service
  • Host Catalog Service
  • Host Service
  • Host Set Service
  • Managed Group Service
  • Role Service
  • Scope Service
  • Session Service
  • Target Service
  • User Service
  • Worker Service

  • Resources

  • Tutorial Library
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Boundary
  3. API
  4. User Service

Boundary Controller HTTP API

User Service


Lists all Users.

Query Parameters

scope_id string
recursive boolean
filter string

Successful Response


id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.


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

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.

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.


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

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.

Path Parameters

id string RequiredRequired

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.


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

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.

Path Parameters

id string RequiredRequired

Successful Response

No content.

Updates a User.

Path Parameters

id string RequiredRequired

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.

Successful Response

id string

Output only. The ID of the User.

scope_id string

The ID of the Scope this resource is in.


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

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.

Path Parameters

id string RequiredRequired

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.


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

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.

Path Parameters

id string RequiredRequired

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.


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

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.

Path Parameters

id string RequiredRequired

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.


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

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

Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)