Identity Providers
This is an object that represents an identity provider for use in authenticating users to access Dremio Cloud.
Identity Provider Object{
"type": "GOOGLE",
"id": "google-oauth2",
"isActive": true
}
Identity Provider Attributes
type
String
The type of identity provider.
EnumAZURE_ID, GITHUB, GOOGLE, LOCAL, MICROSOFT, OKTA
Example GOOGLE
id
String (UUID)
The UUID to identify the identity provider.
Example google-oauth2
isActive
boolean
Set to true if the identity provider is configured and enabled as an option.
Example true
For specific enterprise identity provider attributes, see the associated identity provider pages:
Listing All Identity Providers
Returns a list of all the identity providers and the metadata for each identity provider.
Listing All Identity ProvidersGET /v0/identity-providers
curl -X GET 'https://api.dremio.cloud/v0/identity-providers' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
{
"local": {
"type": "LOCAL",
"id": "hTUxvOBoimCGwtVjh9IFPlic6qhAJZFO",
"isActive": true
},
"social": [
{
"type": "GOOGLE",
"id": "google-oauth2",
"isActive": true
},
{
"type": "GITHUB",
"id": "github",
"isActive": true
},
{
"type": "MICROSOFT",
"id": "windowslive",
"isActive": false
}
],
"enterprise": [
{
"type": "AZURE_AD",
"id": "acd23077-263a-4277-b5f6-926b1983c9de",
"isActive": true,
"domain": "dremio.onmicrosoft.com",
"clientID": "e1cec408-4c58-4283-9b9b-9ec6a6e96f83",
"clientSecret": null
}
]
}
Responses
200
Identity Providers returned successfully
400
Bad input parameter
Adding an Identity Provider
To configure an enterprise identity provider, see the specific identity provider pages:
Retrieving an Identity Provider
Get the identity provider metadata for an existing identity provider by providing the ID.
Retrieving an Identity ProviderGET /v0/identity-providers/{id}
Parameters
id
path
String
The ID of the identity provider you wish to retrieve metadata for.
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'
{
"type": "AZURE_AD",
"id": "acd23077-263a-4277-b5f6-926b1983c9de",
"isActive": true,
"domain": "dremio.onmicrosoft.com",
"clientID": "e1cec408-4c58-4283-9b9b-9ec6a6e96f83",
"clientSecret": null
}
Responses
200
Identity Providers metadata returned successfully
400
Bad input parameter
Deleting an Identity Provider
Delete an enterprise identity provider. Local Authentication and Social Identity Providers (GITHUB
, GOOGLE
, MICROSOFT
) cannot be deleted.
DELETE /v0/identity-providers/{id}
Parameters
id
path
String
The ID of the identity provider that you want to delete.
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'
No response
Responses
200
Identity Providers deleted successfully
400
Bad input parameter