Okta Terraform Provider

https://registry.terraform.io/providers/okta/okta/latest/docs
Admin
The Okta Terraform provider allows you to manage Okta resources, including users, groups, and...
Tokens:2,142
Snippets:6
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Set Okta Environment Variables for Provider Authentication

Source: https://registry.terraform.io/providers/okta/okta/latest/docs/index

This example shows how to set environment variables for Okta provider authentication in a bash shell. It covers setting the organization name, base URL, client ID, private key ID, private key, and scopes, which are then used by Terraform.

```bash
# provider settings established with values from environment variables

# Change place holder values denoted by brackets to real values, including the
# brackets.

$ export OKTA_ORG_NAME="[ORG NAME e.g. dev-123456]"
$ export OKTA_BASE_URL="[okta.com|oktapreview.com]"
$ export OKTA_API_CLIENT_ID="[APP CLIENT_ID]"
$ export OKTA_API_PRIVATE_KEY_ID="[PRIVATE KEY ID - KID]"
$ export OKTA_API_PRIVATE_KEY="[PRIVATE KEY]"
$ export OKTA_API_SCOPES="[COMMA,SEPARATED,SCOPE,VALUES]"

$ terraform plan
```

--------------------------------

### Configure Okta Provider with Environment Variables

Source: https://registry.terraform.io/providers/okta/okta/latest/docs/index

This snippet demonstrates how to configure the Okta provider using environment variables. It shows an empty provider block, relying on environment variables like OKTA_ORG_NAME, OKTA_BASE_URL, OKTA_API_CLIENT_ID, etc., for authentication.

```terraform
provider "okta" {}
```

--------------------------------

### Configure Okta Provider

Source: https://registry.terraform.io/providers/okta/okta/latest/docs/index

This snippet shows how to configure the Okta provider in Terraform for versions 0.14 and later. It specifies the required provider source and version, and includes a block for setting authentication details like organization name, base URL, client ID, private key ID, private key, and scopes.

```terraform
terraform {
  required_providers {
    okta = {
      source = "okta/okta"
      version = "~> 5.3.0"
    }
  }
}

provider "okta" {
  org_name = "[ORG NAME e.g. dev-123456]"
  base_url = "[okta.com|oktapreview.com]"
  client_id = "[APP CLIENT_ID]"
  private_key_id = "[PRIVATE KEY ID - KID]"
  private_key = "[PRIVATE KEY]"
  scopes = "[COMMA,SEPARATED,SCOPE,VALUES]"
}
```

--------------------------------

### Okta Provider Configuration

Source: https://registry.terraform.io/providers/okta/okta/latest/docs/index

Configures the Okta provider for Terraform, specifying authentication details and optional settings for interacting with Okta.

```terraform
provider "okta" {
  org_name         = "your_org_name"
  base_url         = "your_base_url"
  api_token        = "your_api_token"
  # or
  # access_token   = "your_access_token"
  # client_id      = "your_client_id"
  # private_key    = "your_private_key"
  # private_key_id = "your_private_key_id"
  # scopes         = "openid,profile"

  http_proxy       = "your_http_proxy"
  backoff          = true
  min_wait_seconds = 30
  max_wait_seconds = 300
  max_retries      = 5
}
```

--------------------------------

### Okta Provider Configuration

Source: https://registry.terraform.io/providers/okta/okta/latest/docs/index

Configures the Okta Terraform provider with optional settings for request timeouts and API capacity.

```APIDOC
Okta Provider Configuration:
  request_timeout:
    - (Optional) Timeout for a single request in seconds to Okta.
    - Default: 0 (no limit).
    - Maximum value: 300.
  max_api_capacity:
    - (Optional) Sets the percentage of capacity the provider can use of the total rate limit capacity for Okta management API endpoints.
    - Okta API operates in one-minute buckets. See Okta Management API Rate Limits: https://developer.okta.com/docs/reference/rl-global-mgmt.
    - Can be set to a value between 1 and 100.
```

--------------------------------

### Okta Provider Authentication and Rate Limiting

Source: https://registry.terraform.io/providers/okta/okta/latest/docs/index

Details the various authentication methods and rate limiting configurations available for the Okta Terraform provider.

```APIDOC
OktaProviderConfiguration:
  Arguments:
    org_name: (Optional) The org name of your Okta account. Can be sourced from OKTA_ORG_NAME environment variable.
    base_url: (Optional) The domain of your Okta account. Can be sourced from OKTA_BASE_URL environment variable.
    http_proxy: (Optional) A custom URL endpoint for unit testing or local caching proxies. Can be sourced from OKTA_HTTP_PROXY environment variable.
    access_token: (Optional) An OAuth 2.0 access token to interact with your Okta org. Can be sourced from OKTA_ACCESS_TOKEN environment variable. Conflicts with api_token, client_id, scopes, and private_key.
    api_token: (Optional) The API token to interact with your Okta org. Can be sourced from OKTA_API_TOKEN environment variable. Conflicts with access_token, client_id, scopes, and private_key. This is a legacy authorization scheme.
    client_id: (Optional) The client ID for obtaining the API token. Can be sourced from OKTA_API_CLIENT_ID environment variable. Conflicts with access_token and api_token.
    scopes: (Optional) Scopes for obtaining the API token in a comma-separated list. Can be sourced from OKTA_API_SCOPES environment variable. Conflicts with access_token and api_token.
    private_key: (Optional) The private key for obtaining the API token (filepath or key itself). Can be sourced from OKTA_API_PRIVATE_KEY environment variable. Conflicts with access_token and api_token. Supports PKCS#1 or PKCS#8 format.
    private_key_id: (Optional) The private key ID (kid) for obtaining the API token. Can be sourced from OKTA_API_PRIVATE_KEY_ID environment variable. Conflicts with api_token.
    backoff: (Optional) Whether to use exponential backoff strategy for rate limits. Defaults to true.
    min_wait_seconds: (Optional) Minimum seconds to wait when rate limit is hit. Defaults to 30.
    max_wait_seconds: (Optional) Maximum seconds to wait when rate limit is hit. Defaults to 300.
    max_retries: (Optional) Maximum number of retries to attempt before returning an error. Defaults to 5.

  Conflicts:
    - api_token is mutually exclusive with access_token, client_id, private_key_id, private_key, and scopes.
    - access_token conflicts with api_token, client_id, scopes, and private_key.

  Authentication Schemes:
    - SSWS Authorization Scheme (api_token): For org level operations (legacy).
    - OAuth 2.0 client authentication (access_token, client_id, private_key, private_key_id, scopes): For application operations. Recommended.

  Rate Limiting:
    - Configurable via backoff, min_wait_seconds, max_wait_seconds, and max_retries.
```
Tokens:
Raw