Auth tokens

An auth token is a temporary credential that Boundary uses to authenticate API requests from a user.

Boundary creates an auth token when a user successfully authenticates through an auth method. The auth token belongs to the global scope or the organization scope associated with the authenticating account.

You cannot create or update an auth token directly. Boundary creates an auth token when you authenticate. You can read, list, and delete auth tokens. Deleting an auth token revokes it.

Attributes

An auth token has the following attributes:

• id - (output only) The ID of the auth token.

• scope_id - The ID of the scope in which Boundary generated the auth token.

• scope - (output only) Information about the scope in which Boundary generated the auth token.

• token - (output only) The auth token value. Boundary populates this value only after authentication, and it is only ever visible to the end user whose login generated the auth token.

• user_id - (output only) The ID of the user associated with the auth token.

• auth_method_id - (output only) The ID of the auth method associated with the auth token.

• account_id - (output only) The ID of the account associated with the auth token.

• created_time - (output only) The time Boundary created the auth token.

• updated_time - (output only) The time Boundary last updated the auth token.

• approximate_last_used_time - (output only) The approximate time the auth token was last used.

• expiration_time - (output only) The time the auth token expires.

• authorized_actions - (output only) The actions available to the authenticated user for the auth token.

Expiration

Boundary expires an auth token based on two controller configuration parameters:

• auth_token_time_to_live sets the maximum lifetime for all auth tokens. The default is 7 days.

• auth_token_time_to_stale sets the maximum period of inactivity for all auth tokens. The default is 1 day.

Both parameters apply globally to all auth tokens from all auth methods. Refer to the controller configuration documentation for more information.

Service API docs

The following services are relevant to this resource:

• Auth token service