Identity Providers API
| 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 |
| Add an OIDC Identity Provider | POST/auth/identity/oidc |
| Create an Identity Provider | POST/auth/identity |
| Delete an Identity Provider | DELETE/auth/identity/instances/{name} |
Fetch an Identity Provider
Fetch an Identity Provider
fetchIdentityProviderByNameGET
/auth/identity/instances/{name}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | Yes |
Response:
IdentityProviderResponseSecurity Group:
identityPermissions:
read,customFetch All Identity Providers
Fetch All Identity Providers
fetchIdentityProvidersGET
/auth/identity/instancesResponse:
IdentityProviderResponse[]Security Group:
identityPermissions:
read,customAdd a SAML Identity Provider
Add a SAML Identity Provider
addSAMLIdentityProviderPOST
/auth/identity/samlResponse:
IdentityProviderResponseSecurity Group:
identityPermissions:
add,customSAMLIdentityProviderCreateRequest
Required properties
| Property | Type | Description |
|---|---|---|
displayName | string | |
id | string | |
singleSignOnServiceUrl | string |
Add an OIDC Identity Provider
Add an OIDC Identity Provider
addOIDCIdentityProviderPOST
/auth/identity/oidcResponse:
IdentityProviderResponseSecurity Group:
identityPermissions:
add,customOIDCIdentityProviderCreateRequest
Required properties
| Property | Type | Description |
|---|---|---|
displayName | string | |
clientId | string | |
clientSecret | string | |
id | string | |
importConfigUrl | string |
Create an Identity Provider
Create an Identity Provider
createIdentityProviderDeprecatedPOST
/auth/identityResponse:
IdentityProviderResponseSecurity Group:
identityPermissions:
add,customIdentityProviderResponse
Required properties
| Property | Type | Description |
|---|---|---|
displayName | string | |
acsUrl | string | |
callbackUrl | string | |
entityId | string | |
id | string | |
singleSignOnServiceUrl | string | |
type | string |
Delete an Identity Provider
Delete an Identity Provider
deleteIdentityServerInstanceDELETE
/auth/identity/instances/{name}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | Yes |
Response:
voidSecurity Group:
identityPermissions:
delete,custom