IdentityProvidersApi
| Method | HTTP request | Description |
|---|---|---|
| createOidcIdentityProviderUsingPOST | POST /api/web/v1/identityproviders/oidc | Create an OIDC identity provider |
| createSamlIdentityProviderUsingPOST | POST /api/web/v1/identityproviders/saml | Create a SAML identity provider |
| deleteOidcIdentityProviderUsingDELETE | DELETE /api/web/v1/identityproviders/oidc/{id} | Delete an OIDC identity provider |
| deleteSamlIdentityProviderUsingDELETE | DELETE /api/web/v1/identityproviders/saml/{id} | Delete a SAML identity provider |
| fetchOidcConfigurationUsingPOST | POST /api/web/v1/identityproviders/oidc/configuration | Fetch OIDC Configuration for an OIDC identity provider |
| getOidcIdentityProviderUsingGET | GET /api/web/v1/identityproviders/oidc/{id} | Get an OIDC identity provider |
| getSamlIdentityProviderUsingGET | GET /api/web/v1/identityproviders/saml/{id} | Get a SAML identity provider |
| listIdentityProvidersUsingGET | GET /api/web/v1/identityproviders | Lists identity providers |
| listOidcIdentityProvidersUsingGET | GET /api/web/v1/identityproviders/oidc | Lists OIDC identity providers |
| listSamlIdentityProvidersUsingGET | GET /api/web/v1/identityproviders/saml | Lists SAML identity providers |
| updateOidcIdentityProviderUsingPUT | PUT /api/web/v1/identityproviders/oidc/{id} | Update an OIDC identity provider |
| updateSamlIdentityProviderUsingPUT | PUT /api/web/v1/identityproviders/saml/{id} | Update a SAML identity provider |
createOidcIdentityProviderUsingPOST
OidcIdentityProvider createOidcIdentityProviderUsingPOST(oidcIdentityProviderParms)
Create an OIDC identity provider
Create an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oidcIdentityProviderParms | OidcIdentityProviderParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
createSamlIdentityProviderUsingPOST
SamlIdentityProvider createSamlIdentityProviderUsingPOST(samlIdentityProviderParms)
Create a SAML identity provider
Create a SAML identity provider. Caller requires the IDENTITYPROVIDERS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| samlIdentityProviderParms | SamlIdentityProviderParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
deleteOidcIdentityProviderUsingDELETE
deleteOidcIdentityProviderUsingDELETE(id)
Delete an OIDC identity provider
Delete an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the OIDC Identity Provider to delete. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
deleteSamlIdentityProviderUsingDELETE
deleteSamlIdentityProviderUsingDELETE(id)
Delete a SAML identity provider
Delete a SAML identity provider. Caller requires the IDENTITYPROVIDERS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the SAML Identity Provider to delete. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
fetchOidcConfigurationUsingPOST
OidcConfigurationResponse fetchOidcConfigurationUsingPOST(oidcConfigurationParms)
Fetch OIDC Configuration for an OIDC identity provider
Fetch OIDC Configuration for an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oidcConfigurationParms | OidcConfigurationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getOidcIdentityProviderUsingGET
OidcIdentityProvider getOidcIdentityProviderUsingGET(id)
Get an OIDC identity provider
Get an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the OIDC Identity Provider to get. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getSamlIdentityProviderUsingGET
SamlIdentityProvider getSamlIdentityProviderUsingGET(id)
Get a SAML identity provider
Get a SAML identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the SAML Identity Provider to get. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listIdentityProvidersUsingGET
List<IdentityProvider> listIdentityProvidersUsingGET()
Lists identity providers
Lists identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listOidcIdentityProvidersUsingGET
List<OidcIdentityProvider> listOidcIdentityProvidersUsingGET()
Lists OIDC identity providers
Lists OIDC identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listSamlIdentityProvidersUsingGET
List<SamlIdentityProvider> listSamlIdentityProvidersUsingGET()
Lists SAML identity providers
Lists SAML identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateOidcIdentityProviderUsingPUT
OidcIdentityProvider updateOidcIdentityProviderUsingPUT(id, oidcIdentityProviderParms)
Update an OIDC identity provider
Update an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the OIDC Identity Provider to update. | |
| oidcIdentityProviderParms | OidcIdentityProviderParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateSamlIdentityProviderUsingPUT
SamlIdentityProvider updateSamlIdentityProviderUsingPUT(id, samlIdentityProviderParms)
Update a SAML identity provider
Update a SAML identity provider. Caller requires the IDENTITYPROVIDERS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the SAML Identity Provider to update. | |
| samlIdentityProviderParms | SamlIdentityProviderParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |