Skip to main content

Okta

This is an object that represents your identity provider (IdP) when configured to use Okta. You can retrieve it to see what the current configuration is for Okta.

Related information: Identity Providers.

Identity Provider Object
{
  "type": "OKTA",
  "id": "23455721-06a5-43a7-84e2-4b1c770b2bb6",
  "isActive": true,
  "oktaUrl": "https://dcs-4472656d696f.okta.com/oauth2/default/",
  "clientID": "0oa15f7o8yPtoKX0D5d7",
  "clientSecret": null
}

Identity Provider Attributes​

{{< api-section file="data/api/okta.json" data="identityProviderAttributes" >}}

Adding Okta​

Add Okta as an identity provider. After adding an IdP, activate it using the associated endpoint.

Adding Okta
POST /v0/identity-providers

Parameters​

{{< api-section file="data/api/okta.json" data="addingOktaParameters" >}}

note:

For information on how to get the client ID and client secret from the Okta organization, see required Okta properties.

Example Request
curl -X POST 'https://api.dremio.cloud/v0/identity-providers/' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-D '{
     "type": "OKTA",
     "isActive": "false",
     "oktaUrl": "https://dcs-4472656d696f.okta.com/oauth2/default/",
     "clientID": "0oa15f7o8yPtoKX0D5d7",
     "clientSecret": "AA-aOAAaAAAAAaaaaaAaA1aaa2aaAaAaAAaaA3AA"
    }'
Example Response
{
    "id": "c7cfc963-a901-4c19-9d8f-630a7637063e"
}

Responses​

{{< api-responses file="data/api/okta.json" data="addingOktaResponses" >}}

Retrieving Okta​

Get the metadata for the Okta IdP. This is done by providing the ID that returned after initially creating the provider.

Retrieving Okta
GET /v0/identity-providers/{id}

Parameters​

{{< api-section file="data/api/okta.json" data="retrievingOktaParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/identity-providers/acd23077-263a-4277-b5f6-926b1983c9de' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
  "type": "OKTA",
  "id": "c7cfc963-a901-4c19-9d8f-630a7637063e",
  "isActive": false,
  "oktaUrl": "https://dcs-4472656d696f.okta.com/oauth2/default/",
  "clientID": "0oa15f7o8yPtoKX0D5d7",
  "clientSecret": null
}

Responses​

{{< api-responses file="data/api/okta.json" data="retrievingOktaResponses" >}}

Activating Okta​

After adding Okta as an IdP, it must be activated for an organization to begin using it. After completing this action, Okta will display as a login option for users accessing Dremio.

Activating Okta
POST /v0/identity-providers/{id}/activate

Parameters​

{{< api-section file="data/api/okta.json" data="activatingOktaParameters" >}}

Example Request
curl -X POST 'https://api.dremio.cloud/v0/identity-providers/c7cfc963-a901-4c19-9d8f-630a7637063e/activate' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/okta.json" data="activatingOktaResponses" >}}

Deactivating Okta​

Deactivate Okta as an IdP. The Okta option will no longer display at the login page as an authentication option for users to access Dremio Cloud.

Deactivating Okta
POST /v0/identity-providers/{id}/deactivate

Parameters​

{{< api-section file="data/api/okta.json" data="deactivatingOktaParameters" >}}

Example Request
curl -X POST 'https://api.dremio.cloud/v0/identity-providers/c7cfc963-a901-4c19-9d8f-630a7637063e/deactivate' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/okta.json" data="deactivatingOktaResponses" >}}

Deleting Okta​

Delete the Okta IdP. All metadata associated with this IdP is deleted from Dremio Cloud.

Deleting Okta
DELETE /v0/identity-providers/{id}

Parameters​

{{< api-section file="data/api/okta.json" data="deletingOktaParameters" >}}

Example Request
curl -X DELETE 'https://api.dremio.cloud/v0/identity-providers/acd23077-263a-4277-b5f6-926b1983c9de' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/okta.json" data="deletingOktaResponses" >}}