IdentityProvidersApi
| Method | HTTP request | Description |
|---|---|---|
| create_oidc_identity_provider_using_post | POST /api/web/v1/identityproviders/oidc | Create an OIDC identity provider |
| create_saml_identity_provider_using_post | POST /api/web/v1/identityproviders/saml | Create a SAML identity provider |
| delete_oidc_identity_provider_using_delete | DELETE /api/web/v1/identityproviders/oidc/{id} | Delete an OIDC identity provider |
| delete_saml_identity_provider_using_delete | DELETE /api/web/v1/identityproviders/saml/{id} | Delete a SAML identity provider |
| fetch_oidc_configuration_using_post | POST /api/web/v1/identityproviders/oidc/configuration | Fetch OIDC Configuration for an OIDC identity provider |
| get_oidc_identity_provider_using_get | GET /api/web/v1/identityproviders/oidc/{id} | Get an OIDC identity provider |
| get_saml_identity_provider_using_get | GET /api/web/v1/identityproviders/saml/{id} | Get a SAML identity provider |
| list_identity_providers_using_get | GET /api/web/v1/identityproviders | Lists identity providers |
| list_oidc_identity_providers_using_get | GET /api/web/v1/identityproviders/oidc | Lists OIDC identity providers |
| list_saml_identity_providers_using_get | GET /api/web/v1/identityproviders/saml | Lists SAML identity providers |
| update_oidc_identity_provider_using_put | PUT /api/web/v1/identityproviders/oidc/{id} | Update an OIDC identity provider |
| update_saml_identity_provider_using_put | PUT /api/web/v1/identityproviders/saml/{id} | Update a SAML identity provider |
create_oidc_identity_provider_using_post
OidcIdentityProvider create_oidc_identity_provider_using_post(oidc_identity_provider_parms)
Create an OIDC identity provider
Create an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oidc_identity_provider_parms | 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 | - |
create_saml_identity_provider_using_post
SamlIdentityProvider create_saml_identity_provider_using_post(saml_identity_provider_parms)
Create a SAML identity provider
Create a SAML identity provider. Caller requires the IDENTITYPROVIDERS:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| saml_identity_provider_parms | 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 | - |
delete_oidc_identity_provider_using_delete
delete_oidc_identity_provider_using_delete(id)
Delete an OIDC identity provider
Delete an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the OIDC Identity Provider to delete. |
Return type
void (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 | - |
delete_saml_identity_provider_using_delete
delete_saml_identity_provider_using_delete(id)
Delete a SAML identity provider
Delete a SAML identity provider. Caller requires the IDENTITYPROVIDERS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the SAML Identity Provider to delete. |
Return type
void (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 | - |
fetch_oidc_configuration_using_post
OidcConfigurationResponse fetch_oidc_configuration_using_post(oidc_configuration_parms)
Fetch OIDC Configuration for an OIDC identity provider
Fetch OIDC Configuration for an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| oidc_configuration_parms | 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 | - |
get_oidc_identity_provider_using_get
OidcIdentityProvider get_oidc_identity_provider_using_get(id)
Get an OIDC identity provider
Get an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
get_saml_identity_provider_using_get
SamlIdentityProvider get_saml_identity_provider_using_get(id)
Get a SAML identity provider
Get a SAML identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | 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 | - |
list_identity_providers_using_get
List[IdentityProvider] list_identity_providers_using_get()
Lists identity providers
Lists identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
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 | - |
list_oidc_identity_providers_using_get
List[OidcIdentityProvider] list_oidc_identity_providers_using_get()
Lists OIDC identity providers
Lists OIDC identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
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 | - |
list_saml_identity_providers_using_get
List[SamlIdentityProvider] list_saml_identity_providers_using_get()
Lists SAML identity providers
Lists SAML identity providers. Caller requires the IDENTITYPROVIDERS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
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 | - |
update_oidc_identity_provider_using_put
OidcIdentityProvider update_oidc_identity_provider_using_put(id, oidc_identity_provider_parms)
Update an OIDC identity provider
Update an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the OIDC Identity Provider to update. | |
| oidc_identity_provider_parms | 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 | - |
update_saml_identity_provider_using_put
SamlIdentityProvider update_saml_identity_provider_using_put(id, saml_identity_provider_parms)
Update a SAML identity provider
Update a SAML identity provider. Caller requires the IDENTITYPROVIDERS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the SAML Identity Provider to update. | |
| saml_identity_provider_parms | 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 | - |