Okta Auth Method (API)
This is the API documentation for the Vault Okta auth method. For general information about the usage and operation of the Okta method, please see the Vault Okta method documentation.
This documentation assumes the Okta method is mounted at the /auth/okta
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.
Create Configuration
Configures the connection parameters for Okta. This path honors the
distinction between the create
and update
capabilities inside ACL policies.
Method | Path |
---|---|
POST | /auth/okta/config |
Parameters
org_name
(string: <required>)
- Name of the organization to be used in the Okta API.api_token
(string: "")
- Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled. Support for okta auth without api_token is deprecated in Vault 1.4base_url
(string: "")
- If set, will be used as the base domain for API requests. If unset, "okta.com" will be used. Other valid examples are oktapreview.com, and okta-emea.com.bypass_okta_mfa
(bool: false)
- Whether to bypass an Okta MFA request. Useful if using one of Vault's built-in MFA mechanisms, but this will also cause certain other statuses to be ignored, such asPASSWORD_EXPIRED
.
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 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 period, if any, to set on the token.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.
Sample Payload
Sample Request
Read Configuration
Reads the Okta configuration.
Method | Path |
---|---|
GET | /auth/okta/config |
Sample Request
Sample Response
List Users
List the users configured in the Okta method.
Method | Path |
---|---|
LIST | /auth/okta/users |
Sample Request
Sample Response
Register User
Registers a new user and maps a set of policies to it.
Method | Path |
---|---|
POST | /auth/okta/users/:username |
Parameters
username
(string: <required>)
- Name of the user.groups
(array: [])
- List or comma-separated string of groups associated with the user.policies
(array: [])
- List or comma-separated string of policies associated with the user.
Sample Request
Read User
Reads the properties of an existing username.
Method | Path |
---|---|
GET | /auth/okta/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/okta/users/:username |
Parameters
username
(string: <required>)
- Username for this user.
Sample Request
List Groups
List the groups configured in the Okta method.
Method | Path |
---|---|
LIST | /auth/okta/groups |
Sample Request
Sample Response
Register Group
Registers a new group and maps a set of policies to it.
Method | Path |
---|---|
POST | /auth/okta/groups/:name |
Parameters
name
(string: <required>)
- The name of the group.policies
(array: [])
- The list or comma-separated string of policies associated with the group.
Sample Request
Read Group
Reads the properties of an existing group.
Method | Path |
---|---|
GET | /auth/okta/groups/:name |
Parameters
name
(string: <required>)
- The name for the group.
Sample Request
Sample Response
Delete Group
Deletes an existing group from the method.
Method | Path |
---|---|
DELETE | /auth/okta/groups/:name |
Parameters
name
(string: <required>)
- The name for the group.
Sample Request
Login
Login with the username and password.
Method | Path |
---|---|
POST | /auth/okta/login/:username |
Parameters
username
(string: <required>)
- Username for this user.password
(string: <required>)
- Password for the authenticating user.totp
(string: <optional>)
- Okta Verify TOTP passcode.
Sample Payload
Sample Request
Sample Response