A new platform for documentation and tutorials is launching soon.

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

Boundary Controller HTTP API

Auth Token Service

Lists all Auth Tokens.

Request

Query Parameters

scope_id string

recursive boolean

filter string

Response

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

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.

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

Gets a single Auth Token.

Request

Path Parameters

id string Required

Response

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

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.

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

Deletes an Auth Token.

Request

Path Parameters

id string Required

Response

Successful Response

No content.