layout | page_title | description |
---|---|---|
api |
AppRole - Auth Methods - HTTP API |
This is the API documentation for the Vault AppRole auth method. |
This is the API documentation for the Vault AppRole auth method. For general information about the usage and operation of the AppRole method, please see the Vault AppRole method documentation.
This documentation assumes the AppRole method is mounted at the /auth/approle
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.
This endpoint returns a list the existing AppRoles in the method.
Method | Path |
---|---|
LIST |
/auth/approle/role |
$ curl \
--header "X-Vault-Token: ..." \
--request LIST \
http://127.0.0.1:8200/v1/auth/approle/role
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"keys": ["dev", "prod", "test"]
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Creates a new AppRole or updates an existing AppRole. This endpoint
supports both create
and update
capabilities. There can be one or more
constraints enabled on the role. It is required to have at least one of them
enabled while creating or updating a role.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.bind_secret_id
(bool: true)
- Requiresecret_id
to be presented when logging in using this AppRole.secret_id_bound_cidrs
(array: [])
- Comma-separated string or list of CIDR blocks; if set, specifies blocks of IP addresses which can perform the login operation.secret_id_num_uses
(integer: 0)
- Number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID by default will expire. A value of zero will allow unlimited uses. However, this option may be overridden by the request's 'num_uses' field when generating a SecretID.secret_id_ttl
(string: "")
- Duration in either an integer number of seconds (3600
) or an integer time unit (60m
) after which by default any SecretID expires. A value of zero will allow the SecretID to not expire. However, this option may be overridden by the request's 'ttl' field when generating a SecretID.local_secret_ids
(bool: false)
- If set, the secret IDs generated using this role will be cluster local. This can only be set during role creation and once set, it can't be reset later.
@include 'tokenfields.mdx'
{
"token_ttl": "10m",
"token_max_ttl": "15m",
"token_policies": ["default"],
"period": 0,
"bind_secret_id": true
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1
Reads the properties of an existing AppRole.
Method | Path |
---|---|
GET |
/auth/approle/role/:role_name |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/auth/approle/role/application1
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"token_ttl": 1200,
"token_max_ttl": 1800,
"secret_id_ttl": 600,
"secret_id_num_uses": 40,
"token_policies": ["default"],
"period": 0,
"bind_secret_id": true,
"secret_id_bound_cidrs": []
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Deletes an existing AppRole from the method.
Method | Path |
---|---|
DELETE |
/auth/approle/role/:role_name |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.
$ curl \
--header "X-Vault-Token: ..." \
--request DELETE \
http://127.0.0.1:8200/v1/auth/approle/role/application1
Reads the RoleID of an existing AppRole.
Method | Path |
---|---|
GET |
/auth/approle/role/:role_name/role-id |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/auth/approle/role/application1/role-id
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"role_id": "e5a7b66e-5d08-da9c-7075-71984634b882"
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Updates the RoleID of an existing AppRole to a custom value.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/role-id |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.role_id
(string: <required>)
- Value to be set as RoleID.
{
"role_id": "custom-role-id"
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/role-id
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"role_id": "e5a7b66e-5d08-da9c-7075-71984634b882"
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Generates and issues a new SecretID on an existing AppRole. Similar to
tokens, the response will also contain a secret_id_accessor
value which can
be used to read the properties of the SecretID without divulging the SecretID
itself, and also to delete the SecretID from the AppRole.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/secret-id |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.metadata
(string: "")
- Metadata to be tied to the SecretID. This should be a JSON-formatted string containing the metadata in key-value pairs. This metadata will be set on tokens issued with this SecretID, and is logged in audit logs in plaintext.cidr_list
(array: [])
- Comma separated string or list of CIDR blocks enforcing secret IDs to be used from specific set of IP addresses. Ifsecret_id_bound_cidrs
is set on the role, then the list of CIDR blocks listed here should be a subset of the CIDR blocks listed on the role.token_bound_cidrs
(array: [])
- Comma-separated string or list of CIDR blocks; if set, specifies blocks of IP addresses which can use the auth tokens generated by this SecretID. Overrides any role-set value but must be a subset.num_uses
(integer: 0)
- Number of times this SecretID can be used, after which the SecretID expires. A value of zero will allow unlimited uses. Overrides secret_id_num_uses role option when supplied. May not be higher than role's secret_id_num_uses.ttl
(string: "")
- Duration in seconds (3600
) or an integer time unit (60m
) after which this SecretID expires. A value of zero will allow the SecretID to not expire. Overrides secret_id_ttl role option when supplied. May not be longer than role's secret_id_ttl.
{
"metadata": "{ \"tag1\": \"production\" }",
"ttl": 600,
"num_uses": 50
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/secret-id
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"secret_id_accessor": "84896a0c-1347-aa90-a4f6-aca8b7558780",
"secret_id": "841771dc-11c9-bbc7-bcac-6a3945a69cd9",
"secret_id_ttl": 600,
"secret_id_num_uses": 50
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Lists the accessors of all the SecretIDs issued against the AppRole. This includes the accessors for "custom" SecretIDs as well.
Method | Path |
---|---|
LIST |
/auth/approle/role/:role_name/secret-id |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.
$ curl \
--header "X-Vault-Token: ..." \
--request LIST \
http://127.0.0.1:8200/v1/auth/approle/role/application1/secret-id
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"keys": [
"ce102d2a-8253-c437-bf9a-aceed4241491",
"a1c8dee4-b869-e68d-3520-2040c1a0849a",
"be83b7e2-044c-7244-07e1-47560ca1c787",
"84896a0c-1347-aa90-a4f6-aca8b7558780",
"239b1328-6523-15e7-403a-a48038cdc45a"
]
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Reads out the properties of a SecretID.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/secret-id/lookup |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.secret_id
(string: <required>)
- Secret ID attached to the role.
{
"secret_id": "84896a0c-1347-aa90-a4f6-aca8b7558780"
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/secret-id/lookup
Destroy an AppRole secret ID.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/secret-id/destroy |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.secret_id
(string: <required>)
- Secret ID attached to the role.
{
"secret_id": "84896a0c-1347-aa90-a4f6-aca8b7558780"
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/secret-id/destroy
Reads out the properties of a SecretID.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/secret-id-accessor/lookup |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.secret_id_accessor
(string: <required>)
- Secret ID accessor attached to the role.
{
"secret_id_accessor": "84896a0c-1347-aa90-a4f6-aca8b7558780"
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/secret-id-accessor/lookup
Destroy an AppRole secret ID by its accessor.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/secret-id-accessor/destroy |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.secret_id_accessor
(string: <required>)
- Secret ID accessor attached to the role.
{
"secret_id_accessor": "84896a0c-1347-aa90-a4f6-aca8b7558780"
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/secret-id-accessor/destroy
Assigns a "custom" SecretID against an existing AppRole. This is used in the "Push" model of operation.
Method | Path |
---|---|
POST |
/auth/approle/role/:role_name/custom-secret-id |
role_name
(string: <required>)
- Name of the AppRole. Must be less than 4096 bytes.secret_id
(string: <required>)
- SecretID to be attached to the Role.metadata
(string: "")
- Metadata to be tied to the SecretID. This should be a JSON-formatted string containing the metadata in key-value pairs. This metadata will be set on tokens issued with this SecretID, and is logged in audit logs in plaintext.cidr_list
(array: [])
- Comma separated string or list of CIDR blocks enforcing secret IDs to be used from specific set of IP addresses. Ifsecret_id_bound_cidrs
is set on the role, then the list of CIDR blocks listed here should be a subset of the CIDR blocks listed on the role.token_bound_cidrs
(array: [])
- Comma-separated string or list of CIDR blocks; if set, specifies blocks of IP addresses which can use the auth tokens generated by this SecretID. Overrides any role-set value but must be a subset.num_uses
(integer: 0)
- Number of times this SecretID can be used, after which the SecretID expires. A value of zero will allow unlimited uses. Overrides secret_id_num_uses role option when supplied. May not be higher than role's secret_id_num_uses.ttl
(string: "")
- Duration in seconds (3600
) or an integer time unit (60m
) after which this SecretID expires. A value of zero will allow the SecretID to not expire. Overrides secret_id_ttl role option when supplied. May not be longer than role's secret_id_ttl.
{
"secret_id": "testsecretid",
"ttl": 600,
"num_uses": 50
}
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/role/application1/custom-secret-id
{
"auth": null,
"warnings": null,
"wrap_info": null,
"data": {
"secret_id": "testsecretid",
"secret_id_accessor": "84896a0c-1347-aa90-a4f6-aca8b7558780",
"secret_id_ttl": 600,
"secret_id_num_uses": 50
},
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Issues a Vault token based on the presented credentials. role_id
is always
required; if bind_secret_id
is enabled (the default) on the AppRole,
secret_id
is required too. Any other bound authentication values on the
AppRole (such as client IP CIDR) are also evaluated.
Method | Path |
---|---|
POST |
/auth/approle/login |
role_id
(string: <required>)
- RoleID of the AppRole.secret_id
(string: <required>)
- SecretID belonging to AppRole.
{
"role_id": "59d6d1ca-47bb-4e7e-a40b-8be3bc5a0ba8",
"secret_id": "84896a0c-1347-aa90-a4f6-aca8b7558780"
}
$ curl \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/auth/approle/login
{
"auth": {
"renewable": true,
"lease_duration": 1200,
"metadata": null,
"token_policies": ["default"],
"accessor": "fd6c9a00-d2dc-3b11-0be5-af7ae0e1d374",
"client_token": "5b1a0318-679c-9c45-e5c6-d1b9a9035d49"
},
"warnings": null,
"wrap_info": null,
"data": null,
"lease_duration": 0,
"renewable": false,
"lease_id": ""
}
Updates the respective property in the existing AppRole. All of these
parameters of the AppRole can be updated using the /auth/approle/role/:role_name
endpoint directly. The endpoints for each field is provided separately
to be able to delegate specific endpoints using Vault's ACL system.
| Method | Path |
| :---------------- | :---------------------------------------------------- | --------- |
| GET/POST/DELETE
| /auth/approle/role/:role_name/policies
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/secret-id-num-uses
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/secret-id-ttl
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/token-ttl
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/token-max-ttl
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/bind-secret-id
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/secret-id-bound-cidrs
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/token-bound-cidrs
| 200/204
|
| GET/POST/DELETE
| /auth/approle/role/:role_name/period
| 200/204
|
Refer to /auth/approle/role/:role_name
endpoint.
Performs some maintenance tasks to clean up invalid entries that may remain in the token store. Generally, running this is not needed unless upgrade notes or support personnel suggest it. This may perform a lot of I/O to the storage method so should be used sparingly.
Method | Path |
---|---|
POST |
/auth/approle/tidy/secret-id |
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/auth/approle/tidy/secret-id
{
"request_id": "b20b56e3-4699-5b19-cc6b-e74f7b787bbf",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": [
"Tidy operation successfully started. Any information from the operation will be printed to Vault's server logs."
],
"auth": null
}