Creating a Client

The easiest way to get started is to create a config file ~/.okta/okta.yaml that contains your organization URL and API token:

okta:
  client:
    token: <your-super-secret-api-token>
    orgUrl: https://dev-123456.oktapreview.com

Now that you have define the two require fields, you can create a client with a single line of code:

Client client = Clients.builder().build();

Or you can configure these attributes programmatically as well:

Client client = Clients.builder()
        .setClientCredentials(new TokenClientCredentials("<your-super-secret-api-token>"))
        .setOrgUrl("https://dev-123456.oktapreview.com)
        .build();

Now that you have a client, start using it:

client.listUsers()

Configuration

Configuration values are discovered in a hierarchical manor (where each layer can overwrite the previous)

1. classpath:com/okta/sdk/config/okta.yaml
2. classpath:okta.yaml
3. $HOME/.okta/okta.yaml
4. Environment Variables (with dot notation converted to uppercase + underscores)
5. JVM System Properties
6. Programmatically i.e. Clients.builder()

Spring Configuration

If you are using the Okta Spring Boot Starter configuration properties are loaded via Spring's environment in this order:

1. $HOME/.okta/okta.yaml
2. $HOME/.okta/okta.yml
3. Standard Spring Boot External Config resolution

okta.yaml Reference:

okta:
  client:
    token: <string>
    orgUrl: <string>
    connectionTimeout: <int> # of seconds
    proxy:
      port: <int>
      host: <string>
      username: <string>
      password: <string>

System Property Reference:

okta.client.token: <string>
okta.client.orgUrl: <string>
okta.client.connectionTimeout: <int> # of seconds
okta.client.proxy.port: <int>
okta.client.proxy.host: <string>
okta.client.proxy.username: <string>
okta.client.proxy.password: <string>

Environment Variables Reference:

OKTA_CLIENT_TOKEN: <string>
OKTA_CLIENT_ORGURL: <string>
OKTA_CLIENT_CONNECTIONTIMEOUT: <int> # of seconds
OKTA_CLIENT_PROXY_PORT: <int>
OKTA_CLIENT_PROXY_HOST: <string>
OKTA_CLIENT_PROXY_USERNAME: <string>
OKTA_CLIENT_PROXY_PASSWORD: <string>