Identity Providers API

Endpoint Index

Action	Endpoint
Fetch an Identity Provider	GET /auth/identity/instances/{name}
Fetch All Identity Providers	GET /auth/identity/instances
Add a SAML Identity Provider	POST /auth/identity/saml
Create an Identity Provider	POST /auth/identity
Delete an Identity Provider	DELETE /auth/identity/instances/{name}

Fetch an Identity Provider

fetchIdentityProviderByName

GET /auth/identity/instances/{name}

Request Parameters:

Name	Position	Type	Required
name	path	string	required

Response:IdentityProviderResponse
Security Group:identity   Permissions:read,custom

Fetch All Identity Providers

fetchIdentityProviders

GET /auth/identity/instances

Response:IdentityProviderResponse[]
Security Group:identity   Permissions:read,custom

Add a SAML Identity Provider

addSAMLIdentityProvider

POST /auth/identity/saml

Request:SAMLIdentityProviderCreateRequest
Response:IdentityProviderResponse
Security Group:identity   Permissions:add,custom

SAMLIdentityProviderCreateRequest

required
displayName string
id string
singleSignOnServiceUrl string

Create an Identity Provider

Deprecated

createIdentityProvider

This endpoint will be removed in a future release.

POST /auth/identity

Request:SAMLIdentityProviderCreateRequest
Response:IdentityProviderResponse
Security Group:identity   Permissions:add,custom

IdentityProviderResponse

required
displayName string
acsUrl string
callbackUrl string
entityId string
id string
singleSignOnServiceUrl string
type string

Delete an Identity Provider

deleteIdentityProviderInstance

DELETE /auth/identity/instances/{name}

Request Parameters:

Name	Position	Type	Required
name	path	string	required

Response:void
Security Group:identity   Permissions:delete,custom