Skip to main content

Microsoft Azure Active Directory (AAD)

This object allows for the use of Microsoft AAD as an identity provider for accessing Dremio.

Identity Provider Object
{
    "type": "AZURE_AD",
    "id": "acd23077-263a-4277-b5f6-926b1983c9de",
    "isActive": true,
    "domain": "dremio.onmicrosoft.com",
    "clientID": "e1ccc408-4cc8-8883-9b9b-9ec6a6e96fff",
    "clientSecret": null
}

Identity Provider Attributes​

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

Adding Microsoft AAD​

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

Adding Microsoft AAD
POST /v0/identity-providers

Parameters​

{{< api-section file="data/api/microsoft-aad.json" data="addingMicrosoftAadParameters" >}}

note:

For information on how to get the domain, client ID, and client secret from the Azure portal, see required Azure AD properties.

note:

After adding an IdP, activate it using the associated endpoint.

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": "AZURE_AD",
    "isActive": "false",
    "domain": "dremio.onmicrosoft.com",
    "clientID": "e1ccc408-4cc8-8883-9b9b-9ec6a6e96fff",
    "clientSecret": "aaAaA_a1aA1A_A1aaa_1a~aaA1_A11-AA1"
}'
Example Response
{
    "id": "acd23077-263a-4277-b5f6-926b1983c9de"
}

Responses​

{{< api-responses file="data/api/microsoft-aad.json" data="addingMicrosoftAadResponses" >}}

Retrieving Microsoft AAD​

Get the metadata for Microsoft AAD by providing the identity provider ID that was returned on creation.

Retrieving Microsoft AAD
GET /v0/identity-providers/{id}

Parameters​

{{< api-section file="data/api/microsoft-aad.json" data="retrievingMicrosoftAADParameters" >}}

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": "AZURE_AD",
    "id": "acd23077-263a-4277-b5f6-926b1983c9de",
    "isActive": true,
    "domain": "dremio.onmicrosoft.com",
    "clientID": "e1cec408-4c58-4283-9b9b-9ec6a6e96f83",
    "clientSecret": null
}

Responses​

{{< api-responses file="data/api/microsoft-aad.json" data="retrievingMicrosoftAadResponses" >}}

Activating Microsoft AAD​

Activate Microsoft AAD as an identity provider, once configured. This will show Microsoft AAD as an option to users on the Dremio Cloud login page.

Activating Microsoft AAD
POST /v0/identity-providers/{id}/activate

Parameters​

{{< api-section file="data/api/microsoft-aad.json" data="activatingMicrosoftAADParameters" >}}

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

Responses​

{{< api-responses file="data/api/microsoft-aad.json" data="activatingMicrosoftAadResponses" >}}

Deactivating Microsoft AAD​

Deactivate Microsoft AAD. The Microsoft AAD option will no longer be available to users for authentication to Dremio Cloud and it will not be shown on the login page.

Deactivating Microsoft AAD
POST /v0/identity-providers/{id}/deactivate

Parameters​

{{< api-section file="data/api/microsoft-aad.json" data="deactivatingMicrosoftAADParameters" >}}

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

Responses​

{{< api-responses file="data/api/microsoft-aad.json" data="deactivatingMicrosoftAadResponses" >}}

Deleting Microsoft AAD​

Delete Microsoft AAD.

Deleting Microsoft AAD
DELETE /v0/identity-providers/{id}

Parameters​

{{< api-section file="data/api/microsoft-aad.json" data="deletingMicrosoftAADParameters" >}}

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/microsoft-aad.json" data="deletingMicrosoftAadResponses" >}}