IdentityProvidersApi
Method | HTTP request | Description |
---|---|---|
CreateOidcIdentityProviderUsingPOST | POST /api/web/v1/identityproviders/oidc | Create an OIDC identity provider |
DeleteOidcIdentityProviderUsingDELETE | DELETE /api/web/v1/identityproviders/oidc/{id} | Delete an OIDC 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 |
ListOidcIdentityProvidersUsingGET | GET /api/web/v1/identityproviders/oidc | Lists OIDC identity providers |
UpdateOidcIdentityProviderUsingPUT | PUT /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
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 | - |
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
Name | Type | Description | Notes |
---|---|---|---|
id | string | 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 | - |
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
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 (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
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 | - |
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
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 (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
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 | - |