Create an Okta Credential

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "okitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "<string>",
  "oauth2_client_secret": "<string>",
  "oauth2_private_key": "<string>",
  "api_token": "<string>",
  "notes": "<string>"
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "integration_id": "okitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "<string>",
  "oauth2_client_secret": "<string>",
  "oauth2_private_key": "<string>",
  "api_token": "<string>",
  "notes": "<string>"
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials"

payload = {
    "integration_id": "okitg_01hq8xyzabc123def456ghi789",
    "oauth2_client_id": "<string>",
    "oauth2_client_secret": "<string>",
    "oauth2_private_key": "<string>",
    "api_token": "<string>",
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: 'okitg_01hq8xyzabc123def456ghi789',
    oauth2_client_id: '<string>',
    oauth2_client_secret: '<string>',
    oauth2_private_key: '<string>',
    api_token: '<string>',
    notes: '<string>'
  })
};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "okcrd_01hq8xyzabc123def456ghi789",
  "integration_id": "okitg_01hq8xyzabc123def456ghi789",
  "state": "staged",
  "oauth2_auth_method": "client_secret",
  "oauth2_client_id": "<string>",
  "oauth2_scopes": [
    "<string>"
  ],
  "notes": "<string>",
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-05-04T03:27:00Z",
    "activated_at": "2025-03-14T15:07:00Z",
    "expires_at": null,
    "deleted_at": null
  },
  "links": {
    "self": "<string>",
    "integration": "<string>",
    "credentials": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

POST

okta

credentials

Create an Okta Credential

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "okitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "<string>",
  "oauth2_client_secret": "<string>",
  "oauth2_private_key": "<string>",
  "api_token": "<string>",
  "notes": "<string>"
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "integration_id": "okitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "<string>",
  "oauth2_client_secret": "<string>",
  "oauth2_private_key": "<string>",
  "api_token": "<string>",
  "notes": "<string>"
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials"

payload = {
    "integration_id": "okitg_01hq8xyzabc123def456ghi789",
    "oauth2_client_id": "<string>",
    "oauth2_client_secret": "<string>",
    "oauth2_private_key": "<string>",
    "api_token": "<string>",
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: 'okitg_01hq8xyzabc123def456ghi789',
    oauth2_client_id: '<string>',
    oauth2_client_secret: '<string>',
    oauth2_private_key: '<string>',
    api_token: '<string>',
    notes: '<string>'
  })
};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/okta/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "okcrd_01hq8xyzabc123def456ghi789",
  "integration_id": "okitg_01hq8xyzabc123def456ghi789",
  "state": "staged",
  "oauth2_auth_method": "client_secret",
  "oauth2_client_id": "<string>",
  "oauth2_scopes": [
    "<string>"
  ],
  "notes": "<string>",
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-05-04T03:27:00Z",
    "activated_at": "2025-03-14T15:07:00Z",
    "expires_at": null,
    "deleted_at": null
  },
  "links": {
    "self": "<string>",
    "integration": "<string>",
    "credentials": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CreateOktaCredentialRequestData

integration_id

string

required

The ID of the Okta integration this credential belongs to

Pattern: ^okitg_[0-9a-hjkmnp-tv-z]{26}$

Example:

"okitg_01hq8xyzabc123def456ghi789"

oauth2_auth_method

enum<string>

required

The authentication method: api_token (SSWS, live import today), client_secret, or private_key_jwt (OAuth2)

Available options:

client_secret,

private_key_jwt,

api_token

oauth2_client_id

string | null

The OAuth2 client ID. Required for the OAuth2 methods; omitted for the api_token method

oauth2_client_secret

string | null

The OAuth2 client secret (client_secret method)

Pattern: ^[0-9a-zA-Z\.\-]{32,44}$

oauth2_private_key

string | null

The OAuth2 private key JWT (private_key_jwt method)

Pattern: ^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9-_.+/=]*$

api_token

string | null

The Okta SSWS API token (api_token method). A 42-character token, per the Okta API client's connection rules

Pattern: ^[A-Za-z0-9_-]{42}$

notes

string

Optional notes about this credential

Maximum string length: 1000

Response

OktaCredentialDetailedResponseData

string

required

Example:

"okcrd_01hq8xyzabc123def456ghi789"

integration_id

string

required

The ID of the Okta integration this credential belongs to

Example:

"okitg_01hq8xyzabc123def456ghi789"

state

enum<string>

required

The current lifecycle state of the credential


`staged` The record is staged and is only visible to administrators or in the API. Use the `activate` method during your change window.
`active` The record is active.
`expiring` The `expires_at` value is set in the future for the record. You can run the `activate` action to remove the scheduled expiration.
`expired` The `expires_at` value is in the past and the record was deactivated.
`deactivated` The record was deactivated manually by an administrator.

Available options:

staged,

active,

expiring,

expired,

deactivated

Example:

"staged"

oauth2_auth_method

enum<string>

required

The OAuth2 authentication method

Available options:

client_secret,

private_key_jwt,

api_token

Example:

"client_secret"

oauth2_client_id

string

required

The OAuth2 client ID

oauth2_scopes

string[] | null

required

The OAuth2 scopes

notes

string | null

required

Optional notes

timestamp

TimestampStateData · object

required

The timestamps for the credential record

Show child attributes

links

object

required

API hyperlinks related to the record

Show child attributes

Getting Started

Endpoints

Create an Okta Credential

Authorizations

Body

Response