Skip to content

credentials setup instructions #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edunham wants to merge 1 commit into
base: main
Choose a base branch
from
Open

credentials setup instructions #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@ The Okta CLI looks for configuration in the following sources:
1. A `.okta.yaml` file in the application or project's root directory
1. Environment variables

### YAML configuration
### YAML configuration

Use either an API token or an OAuth 2.0 Application to give the CLI client access to your organization.

#### API Token Setup

To use token auth, follow the [API Token help guide](https://help.okta.com/en-us/content/topics/security/api.htm?cshid=ext-create-api-token#create-okta-api-token) to create an API token the Okta organization where you want to grant access to the CLI client.

When you use an API Token instead of OAuth 2.0 the full YAML configuration
looks like:
Expand All @@ -62,6 +68,10 @@ okta:
token: {apiToken}
```

#### OAuth 2.0 Setup

To use OAuth 2.0, follow the [app setup guide](https://help.okta.com/en-us/content/topics/apps/apps_app_integration_wizard_oidc.htm) to create an OIDC app for the CLI client, and then follow the [secrets management guide](https://help.okta.com/en-us/content/topics/apps/oauth-client-cred-mgmt.htm) to generate your keypair.

When you use OAuth 2.0 the full YAML configuration looks like:

```yaml
Expand Down