» 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 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 if token_ttl and token_max_ttl would otherwise allow a renewal.
  • token_no_default_policy (bool: false) - If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
  • token_num_uses (integer: 0) - The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
  • 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 be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

» Sample Payload

{
  "host": "radius.myorg.com",
  "port": 1812,
  "secret": "mySecret"
}

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/auth/radius/config

» 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 the default policy will be applicable to the user.
{
  "policies": "dev,prod",
}

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/auth/radius/users/test-user

» 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

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/auth/radius/users/test-user

» Sample Response

{
  "request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
  "lease_id": "",
  "lease_duration": 0,
  "renewable": false,
  "data": {
    "policies": "default,dev"
  },
  "warnings": null
}

» 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

$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/auth/radius/users/test-user

» List Users

List the users registered with the method.

Method Path
LIST /auth/radius/users

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/auth/radius/users

» Sample Response

{
  "auth": null,
  "warnings": null,
  "wrap_info": null,
  "data": {
    "keys": [
      "devuser",
        "produser"
    ]
  },
  "lease_duration": 0,
  "renewable": false,
  "lease_id": ""
}

» 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

{
  "password": "Password!"
}

» Sample Request

$ curl \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/auth/radius/login/test-user

» Sample Response

{
  "lease_id": "",
  "renewable": false,
  "lease_duration": 0,
  "data": null,
  "warnings": null,
  "auth": {
    "client_token": "64d2a8f2-2a2f-5688-102b-e6088b76e344",
    "accessor": "18bb8f89-826a-56ee-c65b-1736dc5ea27d",
    "policies": ["default"],
    "metadata": {
      "username": "vishal"
    },
  },
  "lease_duration": 7200,
  "renewable": true
}