RADIUS auth method (API)
This is the API documentation for the Vault RADIUS auth method. For general information about the usage and operation of the RADIUS method, please see the Vault RADIUS method documentation.
This documentation assumes the RADIUS method is mounted at the /auth/radius
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.
Configure RADIUS
Configures the connection parameters and shared secret used to communicate with RADIUS.
Method | Path |
---|---|
POST | /auth/radius/config |
Parameters
host
(string: <required>)
- The RADIUS server to connect to. Examples:radius.myorg.com
,127.0.0.1
port
(integer: 1812)
- The UDP port where the RADIUS server is listening on. Defaults is 1812.secret
(string: <required>)
- The RADIUS shared secret.unregistered_user_policies
(string: "")
- A comma-separated list of policies to be granted to unregistered users.dial_timeout
(integer: 10)
- Number of second to wait for a backend connection before timing out. Default is 10.nas_port
(integer: 10)
- The NAS-Port attribute of the RADIUS request. Defaults is 10.
token_ttl
(integer: 0 or string: "")
- The incremental lifetime for generated tokens. This current value of this will be referenced at renewal time.token_max_ttl
(integer: 0 or string: "")
- The maximum lifetime for generated tokens. This current value of this will be referenced at renewal time.token_policies
(array: [] or comma-delimited string: "")
- List of token policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.policies
(array: [] or comma-delimited string: "")
- DEPRECATED: Please use thetoken_policies
parameter instead. List of token policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
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_ttl
andtoken_max_ttl
would otherwise allow a renewal.token_no_default_policy
(bool: false)
- If set, thedefault
policy 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 maximum allowed period value when a periodic token is requested from this role.token_type
(string: "")
- The type of token that should be generated. Can beservice
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time. For machine based authentication cases, you should usebatch
type tokens.
Sample payload
Sample request
Register user
Registers a new user and maps a set of policies to it. This path honors the
distinction between the create
and update
capabilities inside ACL policies.
Method | Path |
---|---|
POST | /auth/radius/users/:username |
Parameters
username
(string: <required>)
- Username for this user.policies
(string: "")
- Comma-separated list of policies. If set to empty string, only thedefault
policy will be applicable to the user.
Sample request
Read user
Reads the properties of an existing username.
Method | Path |
---|---|
GET | /auth/radius/users/:username |
Parameters
username
(string: <required>)
- Username for this user.
Sample request
Sample response
Delete user
Deletes an existing username from the method.
Method | Path |
---|---|
DELETE | /auth/radius/users/:username |
Parameters
username
(string: <required>)
- Username for this user.
Sample request
List users
List the users registered with the method.
Method | Path |
---|---|
LIST | /auth/radius/users |
Sample request
Sample response
Login
Login with the username and password.
Method | Path |
---|---|
POST | /auth/radius/login |
POST | /auth/radius/login/:username |
Parameters
username
(string: <required>)
- Username for this user.password
(string: <required>)
- Password for the authenticating user.
Sample payload
Sample request
Sample response