auth/okta: documents API token minimal permissions (#15566)

This commit is contained in:
Austin Gebauer 2022-05-23 14:57:14 -07:00 committed by GitHub
parent a3b0b60a73
commit 6fe639eb35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 1 deletions

View File

@ -134,6 +134,19 @@ management tool.
will need to re-authenticate. You can force this by revoking the
existing tokens.
### Okta API Token Permissions
The `okta` auth method uses the [Authentication](https://developer.okta.com/docs/reference/api/authn/)
and [User Groups](https://developer.okta.com/docs/reference/api/users/#get-user-s-groups)
APIs to authenticate users and obtain their group membership. The [`api_token`](/api-docs/auth/okta#api_token)
provided to the auth method's configuration must have sufficient privileges to exercise
these Okta APIs.
It is recommended to configure the auth method with a minimally permissive API token.
To do so, create the API token using an administrator with the standard
[Read-only Admin](https://help.okta.com/en/prod/Content/Topics/Security/administrators-read-only-admin.htm)
role. Custom roles may also be used to grant minimal permissions to the Okta API token.
## API
The Okta auth method has a full HTTP API. Please see the

View File

@ -6,7 +6,7 @@ description: The token store auth method is used to authenticate using tokens.
# Token Auth Method
The `token` method is built-in and automatically available at `/auth/token`. It
The `token` auth method is built-in and automatically available at `/auth/token`. It
allows users to authenticate using a token, as well to create new tokens, revoke
secrets by token, and more.