Boundary controller HTTP API
Account Service
Lists all accounts in a specific auth method.
Query Parameters
auth_method_id string The id of the auth method whose accounts should be listed.
filter string Filter can be specified to only return items that match the filter. See filter expressions for more information.
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. To learn more about list pagination in Boundary, refer to list pagination.
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, the page size will be truncated to this number.
Creates a single account in the provided auth method.
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. Not required when creating an account.
type string The type of this account. If not set, this is inferred from the type of the auth method.
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. The schema of this field depends on the type of the auth method that the account is being created in. For password auth methods, the parameters are:
{
"login_name": "login_name",
"password": "password"
}
For OIDC auth methods, the parameters are:
{
"issuer": "issuer",
"subject": "subject",
"full_name": "full_name",
"email": "email",
"token_claims": {},
"userinfo_claims": {}
}
For LDAP auth methods, the parameters are:
{
"login_name": "login_name",
"full_name": "full_name",
"email": "email",
"dn": "dn",
"member_of_groups": ["member_of_groups"]
}
Gets a single account based on the input id
Path Parameters
id string RequiredThe id of the account that should be retrieved.
Deletes an account.
Path Parameters
id string RequiredThe id of the account to delete.
Updates an account.
Path Parameters
id string RequiredThe id of the account that should be updated.
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. Not required when creating an account.
type string The type of this account. If not set, this is inferred from the type of the auth method.
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. The schema of this field depends on the type of the auth method that the account is being created in. For password auth methods, the parameters are:
{
"login_name": "login_name",
"password": "password"
}
For OIDC auth methods, the parameters are:
{
"issuer": "issuer",
"subject": "subject",
"full_name": "full_name",
"email": "email",
"token_claims": {},
"userinfo_claims": {}
}
For LDAP auth methods, the parameters are:
{
"login_name": "login_name",
"full_name": "full_name",
"email": "email",
"dn": "dn",
"member_of_groups": ["member_of_groups"]
}
Sets the password for the provided account.
Path Parameters
id string RequiredThe id of the account for which the password should be changed.
Body Parameters
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 The current password for the account.
new_password string The new password that should be set.
Sets the password for the provided account.
Path Parameters
id string RequiredThe id of the account for which the password should be set.
Body Parameters
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 The password that should be set.