Skip to main content

IdentityProvidersApi

MethodHTTP requestDescription
CreateOidcIdentityProviderUsingPOSTPOST /api/web/v1/identityproviders/oidcCreate an OIDC identity provider
DeleteOidcIdentityProviderUsingDELETEDELETE /api/web/v1/identityproviders/oidc/{id}Delete an OIDC identity provider
FetchOidcConfigurationUsingPOSTPOST /api/web/v1/identityproviders/oidc/configurationFetch OIDC Configuration for an OIDC identity provider
GetOidcIdentityProviderUsingGETGET /api/web/v1/identityproviders/oidc/{id}Get an OIDC identity provider
ListOidcIdentityProvidersUsingGETGET /api/web/v1/identityproviders/oidcLists OIDC identity providers
UpdateOidcIdentityProviderUsingPUTPUT /api/web/v1/identityproviders/oidc/{id}Update an OIDC identity provider

CreateOidcIdentityProviderUsingPOST

OidcIdentityProvider CreateOidcIdentityProviderUsingPOST (OidcIdentityProviderParms oidcIdentityProviderParms)

Create an OIDC identity provider

Create an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:ADD permission.

Using the CreateOidcIdentityProviderUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
oidcIdentityProviderParmsOidcIdentityProviderParms

Return type

OidcIdentityProvider

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

DeleteOidcIdentityProviderUsingDELETE

void DeleteOidcIdentityProviderUsingDELETE (string id)

Delete an OIDC identity provider

Delete an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:REMOVE permission.

Example

Using the DeleteOidcIdentityProviderUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe UUID of the OIDC Identity Provider to delete.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

FetchOidcConfigurationUsingPOST

OidcConfigurationResponse FetchOidcConfigurationUsingPOST (OidcConfigurationParms oidcConfigurationParms)

Fetch OIDC Configuration for an OIDC identity provider

Fetch OIDC Configuration for an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.

Example

Using the FetchOidcConfigurationUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
oidcConfigurationParmsOidcConfigurationParms

Return type

OidcConfigurationResponse

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

GetOidcIdentityProviderUsingGET

OidcIdentityProvider GetOidcIdentityProviderUsingGET (string id)

Get an OIDC identity provider

Get an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.

Example

Using the GetOidcIdentityProviderUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe UUID of the OIDC Identity Provider to get.

Return type

OidcIdentityProvider

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

ListOidcIdentityProvidersUsingGET

List<OidcIdentityProvider> ListOidcIdentityProvidersUsingGET ()

Lists OIDC identity providers

Lists OIDC identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.

Example

Using the ListOidcIdentityProvidersUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

This endpoint does not need any parameter.

Return type

List<OidcIdentityProvider>

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

UpdateOidcIdentityProviderUsingPUT

OidcIdentityProvider UpdateOidcIdentityProviderUsingPUT (string id, OidcIdentityProviderParms oidcIdentityProviderParms)

Update an OIDC identity provider

Update an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:EDIT permission.

Example

Using the UpdateOidcIdentityProviderUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

NameTypeDescriptionNotes
idstringThe UUID of the OIDC Identity Provider to update.
oidcIdentityProviderParmsOidcIdentityProviderParms

Return type

OidcIdentityProvider

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-