# Identity Providers API



<EndpointIndex
  names={[
  	'fetchIdentityProviderByName',
  	'fetchIdentityProviders',
  	'addSAMLIdentityProvider',
  	'addOIDCIdentityProvider',
  	'createIdentityProvider',
  	'deleteIdentityServerInstance',
  ]}
  titles={{
  	fetchIdentityProviderByName: 'Fetch an Identity Provider',
  	fetchIdentityProviders: 'Fetch All Identity Providers',
  	addSAMLIdentityProvider: 'Add a SAML Identity Provider',
  	addOIDCIdentityProvider: 'Add an OIDC Identity Provider',
  	createIdentityProvider: 'Create an Identity Provider',
  	deleteIdentityServerInstance: 'Delete an Identity Provider',
  }}
/>

Fetch an Identity Provider [#fetch-an-identity-provider]

<ApiEndpoint name="fetchIdentityProviderByName" title="Fetch an Identity Provider" />

Fetch All Identity Providers [#fetch-all-identity-providers]

<ApiEndpoint name="fetchIdentityProviders" title="Fetch All Identity Providers" />

Add a SAML Identity Provider [#add-a-saml-identity-provider]

<ApiEndpoint name="addSAMLIdentityProvider" title="Add a SAML Identity Provider" />

<ApiSchema name="SAMLIdentityProviderCreateRequest" />

Add an OIDC Identity Provider [#add-an-oidc-identity-provider]

<ApiEndpoint name="addOIDCIdentityProvider" title="Add an OIDC Identity Provider" />

<ApiSchema name="OIDCIdentityProviderCreateRequest" />

Create an Identity Provider [#create-an-identity-provider]

<ApiEndpoint name="createIdentityProvider" title="Create an Identity Provider" />

<ApiSchema name="IdentityProviderResponse" />

Delete an Identity Provider [#delete-an-identity-provider]

<ApiEndpoint name="deleteIdentityServerInstance" title="Delete an Identity Provider" />


## API Reference

GET /auth/identity/instances/{name} — fetchIdentityProviderByName
Tags: identity-providers-controller
Permissions: read, custom
Parameters:
  name (string, path, required)
Responses:
  200 IdentityProviderResponse — OK

GET /auth/identity/instances — fetchIdentityProviders
Tags: identity-providers-controller
Permissions: read, custom
Responses:
  200 IdentityProviderResponse[] — OK

POST /auth/identity/saml — addSAMLIdentityProvider
Tags: identity-providers-controller
Permissions: add, custom
Request body (SAMLIdentityProviderCreateRequest):
Responses:
  200 IdentityProviderResponse — OK

POST /auth/identity/oidc — addOIDCIdentityProvider
Tags: identity-providers-controller
Permissions: add, custom
Request body (OIDCIdentityProviderCreateRequest):
Responses:
  200 IdentityProviderResponse — OK

POST /auth/identity — createIdentityProvider
Tags: identity-providers-controller
Permissions: add, custom
Request body (SAMLIdentityProviderCreateRequest):
Responses:
  200 IdentityProviderResponse — OK

DELETE /auth/identity/instances/{name} — deleteIdentityServerInstance
Tags: identity-providers-controller
Permissions: delete, custom
Parameters:
  name (string, path, required)
Responses:
  200 — OK

SAMLIdentityProviderCreateRequest
Properties:
  id (string, required)
  displayName (string, required)
  singleSignOnServiceUrl (string, required)

OIDCIdentityProviderCreateRequest
Properties:
  id (string, required)
  displayName (string, required)
  importConfigUrl (string, required)
  clientId (string, required)
  clientSecret (string, required)

IdentityProviderResponse
Properties:
  id (string, required)
  displayName (string, required)
  type (string, required)
  acsUrl (string, required)
  callbackUrl (string, required)
  entityId (string, required)
  singleSignOnServiceUrl (string, required)