Boundary controller HTTP API

Auth Token Service

List Auth TokensGET/v1/auth-tokens

Lists all Auth Tokens.

Query Parameters

scope_id string

recursive boolean

filter string

You can specify that the filter should only return items that match. Refer to filter expressions for more information.

list_token string

An opaque token that Boundary uses to continue an existing iteration or request updated items. If you do not specify a token, pagination starts 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 you do not set a page size, Boundary uses the configured default page size. If the page_size is greater than the default page size configured, Boundary truncates the page size to this number.

Successful Response

items object[]

AuthToken contains all fields related to an Auth Token resource

id string

Output only. The ID of the Auth Token.

scope_id string

The Scope in which this Auth Token was generated.

scope object

Output only. Scope information for this resource.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it is the "global" scope.

token string

Output only. The token value, which will only be populated after authentication and is only ever visible to the end user whose login request resulted in this Auth Token being created.

user_id string

Output only. The ID of the User associated with this Auth Token.

auth_method_id string

Output only. The ID of the Auth Method associated with this Auth Token.

account_id string

Output only. The ID of the Account associated with this Auth Token.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

approximate_last_used_time string

Output only. The approximate time this Auth Token was last used.

expiration_time string

Output only. The time this Auth Token expires.

authorized_actions string[]

response_type string

The type of response, either "delta" or "complete". Delta signifies that this is part of a paginated result or an update to a previously completed pagination. Complete signifies that it is the last page.

list_token string

An opaque token used to continue an existing pagination or request updated items. Use this token in the next list request to request the next page.

sort_by string

The name of the field which the items are sorted by.

sort_dir string

The direction of the sort, either "asc" or "desc".

removed_ids string[]

est_item_count integer

An estimate at the total items available. This may change during pagination.

Get Auth TokenGET/v1/auth-tokens/{id}

Gets a single Auth Token.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the Auth Token.

scope_id string

The Scope in which this Auth Token was generated.

scope object

Output only. Scope information for this resource.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it is the "global" scope.

token string

Output only. The token value, which will only be populated after authentication and is only ever visible to the end user whose login request resulted in this Auth Token being created.

user_id string

Output only. The ID of the User associated with this Auth Token.

auth_method_id string

Output only. The ID of the Auth Method associated with this Auth Token.

account_id string

Output only. The ID of the Account associated with this Auth Token.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

approximate_last_used_time string

Output only. The approximate time this Auth Token was last used.

expiration_time string

Output only. The time this Auth Token expires.

authorized_actions string[]

Delete Auth TokenDELETE/v1/auth-tokens/{id}

Deletes an Auth Token.

Path Parameters

id string