»Token Auth Method (API)
This is the API documentation for the Vault token auth method. For general information about the usage and operation of the token method, please see the Vault Token method documentation.
»List Accessors
This endpoint lists token accessor. This requires sudo capability, and access
to it should be tightly controlled as the accessors can be used to revoke very
large numbers of tokens and their associated leases at once.
| Method | Path |
|---|---|
LIST | /auth/token/accessors |
»Sample Request
»Sample Response
»Create Token
Creates a new token. Certain options are only available when called by a
root token. If used via the /auth/token/create-orphan endpoint, a root
token is not required to create an orphan token (otherwise set with the
no_parent option). If used with a role name in the path, the token will
be created against the specified role name; this may override options set
during this call.
| Method | Path |
|---|---|
POST | /auth/token/create |
POST | /auth/token/create-orphan |
POST | /auth/token/create/:role_name |
»Parameters
id(string: "")– The ID of the client token. Can only be specified by a root token. The ID provided may not contain a.character. Otherwise, the token ID is a randomly generated value.Note: The ID should not start with the
s.prefix.role_name(string: "")– The name of the token role.policies(array: "")– A list of policies for the token. This must be a subset of the policies belonging to the token making the request, unless root. If not specified, defaults to all the policies of the calling token.meta(map: {})– A map of string to string valued metadata. This is passed through to the audit devices.no_parent(bool: false)- This argument only has effect if used by a root or sudo caller. When set to true, the token created will not have a parent.no_default_policy(bool: false)- If true thedefaultpolicy will not be contained in this token's policy set.renewable(bool: true)- Set tofalseto disable the ability of the token to be renewed past its initial TTL. Setting the value totruewill allow the token to be renewable up to the system/mount maximum TTL.lease(string: "")- DEPRECATED; usettlinsteadttl(string: "")- The TTL period of the token, provided as "1h", where hour is the largest suffix. If not provided, the token is valid for the default lease TTL, or indefinitely if the root policy is used.type(string: "")- The token type. Can be "batch" or "service". Defaults to the type specified by the role configuration named byrole_name.explicit_max_ttl(string: "")- If set, the token will have an explicit max TTL set upon it. This maximum token TTL cannot be changed later, and unlike with normal tokens, updates to the system/mount max TTL value will have no effect at renewal time -- the token will never be able to be renewed or used past the value set at issue time.display_name(string: "token")- The display name of the token.num_uses(integer: 0)- The maximum uses for the given token. This can be used to create a one-time-token or limited use token. The value of 0 has no limit to the number of uses.period(string: "")- If specified, the token will be periodic; it will have no maximum TTL (unless an "explicit-max-ttl" is also set) but every renewal will use the given period. Requires a root token or one with the sudo capability.entity_alias(string: "")- Name of the entity alias to associate with during token creation. Only works in combination withrole_nameargument and used entity alias must be listed inallowed_entity_aliases. If this has been specified, the entity will not be inherited from the parent.
»Sample Payload
»Sample Request
»Sample Response
»Lookup a Token
Returns information about the client token.
| Method | Path |
|---|---|
POST | /auth/token/lookup |
»Parameters
token(string: <required>)- Token to lookup.
»Sample Payload
»Sample Request
»Sample Response
»Lookup a Token (Self)
Returns information about the current client token.
| Method | Path |
|---|---|
GET | /auth/token/lookup-self |
»Sample Request
»Sample Response
»Lookup a Token (Accessor)
Returns information about the client token from the accessor.
| Method | Path |
|---|---|
POST | /auth/token/lookup-accessor |
»Parameters
accessor(string: <required>)- Token accessor to lookup.
»Sample Payload
»Sample Request
»Sample Response
»Renew a Token
Renews a lease associated with a token. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.
| Method | Path |
|---|---|
POST | /auth/token/renew |
»Parameters
token(string: <required>)- Token to renew. This can be part of the URL or the body.increment(string: "")- An optional requested lease increment can be provided. This increment may be ignored.
»Sample Payload
»Sample Request
»Sample Response
»Renew a Token (Self)
Renews a lease associated with the calling token. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.
| Method | Path |
|---|---|
POST | /auth/token/renew-self |
»Parameters
increment(string: "")- An optional requested lease increment can be provided. This increment may be ignored.
»Sample Payload
»Sample Request
»Sample Response
»Renew a Token (Accessor)
Renews a lease associated with a token using its accessor. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.
| Method | Path |
|---|---|
POST | /auth/token/renew-accessor |
»Parameters
accessor(string: <required>)- Accessor associated with the token to renew.increment(string: "")- An optional requested lease increment can be provided. This increment may be ignored.
»Sample Payload
»Sample Request
»Sample Response
»Revoke a Token
Revokes a token and all child tokens. When the token is revoked, all dynamic secrets generated with it are also revoked.
| Method | Path |
|---|---|
POST | /auth/token/revoke |
»Parameters
token(string: <required>)- Token to revoke.
»Sample Payload
»Sample Request
»Revoke a Token (Self)
Revokes the token used to call it and all child tokens. When the token is revoked, all dynamic secrets generated with it are also revoked.
| Method | Path |
|---|---|
POST | /auth/token/revoke-self |
»Sample Request
»Revoke a Token Accessor
Revoke the token associated with the accessor and all the child tokens. This is meant for purposes where there is no access to token ID but there is need to revoke a token and its children.
| Method | Path |
|---|---|
POST | /auth/token/revoke-accessor |
»Parameters
accessor(string: <required>)- Accessor of the token.
»Sample Payload
»Sample Request
»Revoke Token and Orphan Children
Revokes a token but not its child tokens. When the token is revoked, all secrets
generated with it are also revoked. All child tokens are orphaned, but can be
revoked sub-sequently using /auth/token/revoke/. This is a root-protected
endpoint.
| Method | Path |
|---|---|
POST | /auth/token/revoke-orphan |
»Parameters
token(string: <required>)- Token to revoke. This can be part of the URL or the body.
»Sample Payload
»Sample Request
»Read Token Role
Fetches the named role configuration.
| Method | Path |
|---|---|
GET | /auth/token/roles/:role_name |
»Parameters
role_name(string: <required>)- The name of the token role.
»Sample Request
»Sample Response
»List Token Roles
List available token roles.
| Method | Path |
|---|---|
LIST | /auth/token/roles |
»Sample Request
»Sample Response
»Create/Update Token Role
Creates (or replaces) the named role. Roles enforce specific behavior when
creating tokens that allow token functionality that is otherwise not
available or would require sudo/root privileges to access. Role
parameters, when set, override any provided options to the create
endpoints. The role name is also included in the token path, allowing all
tokens created against a role to be revoked using the
/sys/leases/revoke-prefix endpoint.
| Method | Path |
|---|---|
POST | /auth/token/roles/:role_name |
»Parameters
role_name(string: <required>)– The name of the token role.allowed_policies(list: [])– If set, tokens can be created with any subset of the policies in this list, rather than the normal semantics of tokens being a subset of the calling token's policies. The parameter is a comma-delimited string of policy names. If at creation timeno_default_policyis not set and"default"is not contained indisallowed_policies, the"default"policy will be added to the created token automatically.disallowed_policies(list: [])– If set, successful token creation via this role will require that no policies in the given list are requested. The parameter is a comma-delimited string of policy names. Adding"default"to this list will prevent"default"from being added automatically to created tokens.orphan(bool: false)- Iftrue, tokens created against this policy will be orphan tokens (they will have no parent). As such, they will not be automatically revoked by the revocation of any other token.renewable(bool: true)- Set tofalseto disable the ability of the token to be renewed past its initial TTL. Setting the value totruewill allow the token to be renewable up to the system/mount maximum TTL.path_suffix(string: "")- If set, tokens created against this role will have the given suffix as part of their path in addition to the role name. This can be useful in certain scenarios, such as keeping the same role name in the future but revoking all tokens created against it before some point in time. The suffix can be changed, allowing new callers to have the new suffix as part of their path, and then tokens with the old suffix can be revoked via/sys/leases/revoke-prefix.allowed_entity_aliases(string: "", or list: [])- String or JSON list of allowed entity aliases. If set, specifies the entity aliases which are allowed to be used during token generation. This field supports globbing. Note thatallowed_entity_aliasesis not case sensitive.
token_bound_cidrs(array: [] or comma-delimited string: "")- List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.token_explicit_max_ttl(integer: 0 or string: "")- If set, will encode an explicit max TTL onto the token. This is a hard cap even iftoken_ttlandtoken_max_ttlwould otherwise allow a renewal.token_no_default_policy(bool: false)- If set, thedefaultpolicy will not be set on generated tokens; otherwise it will be added to the policies set intoken_policies.token_num_uses(integer: 0)- The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited. If you require the token to have the ability to create child tokens, you will need to set this value to 0.token_period(integer: 0 or string: "")- The period, if any, to set on the token.token_type(string: "")- The type of token that should be generated. Can beservice,batch, ordefaultto use the mount's tuned default (which unless changed will beservicetokens). For token store roles, there are two additional possibilities:default-serviceanddefault-batchwhich specify the type to return unless the client requests a different type at generation time.
»Sample Payload
»Sample Request
»Delete Token Role
This endpoint deletes the named token role.
| Method | Path |
|---|---|
DELETE | /auth/token/roles/:role_name |
»Parameters
role_name(string: <required>)- The name of the token role.
»Sample Request
»Tidy Tokens
Performs some maintenance tasks to clean up invalid entries that may remain in the token store. On Enterprise, Tidy will only impact the tokens in the specified namespace, or the root namespace if unspecified.
Generally, running this is not needed unless upgrade notes or support personnel
suggest it. There are two potential dangers to running tidy: first, this will
perform a lot of read I/O to the storage method, as it will essentially reload the
entirety of the token store into memory. Depending on how much cleanup is
required (usually very little) there may also be a large number of writes.
Second, this will cause Vault's memory usage to balloon up, because the default
Vault internal cache is unlimited in size and every value read from storage will
be cached. Listing the /auth/token/accessors endpoint is a good way to get
some sense of the potential impact: tidy does this and more, so if this call creates problems
for your cluster, it would be wise to give Vault more resources before attempting
tidy. Note that the request may time out depending on
max duration
and your client's timeout configuration, make sure to allow it run to completion
to properly judge the impact.
Tidy will load every token accessor and cubbyhole in the namespace, as well as all the secondary index entries that are used to group tokens into trees so that parent token revocation also revokes child tokens.
For each parent token listed in the secondary index, tidy will check if the token still exists in storage, and if not its child tokens that still exist will be made orphans, then the parent token will be removed from the secondary index.
For each accessor found, tidy will check if the corresponding token still exists in storage, and if not will delete the accessor. If the token still exists in storage but shouldn't, tidy will try to revoke it and any child leases it might have, then delete the accessor.
Finally, any cubbyhole entries that are associated with tokens which weren't deemed valid in the above steps will be deleted.
| Method | Path |
|---|---|
POST | /auth/token/tidy |
»Sample Request
»Sample Response
