REresilio
CustomOIDC

Configure Custom OIDC settings

Configure Custom OIDC settings. Returns Custom OIDC settings. See get Custom OIDC settings for the response details.

put/custom-oidc

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Request body

idp_namestring

Custom OIDC Identity Provider name. This parameter is not required if the purpose of the request is to disable Custom OIDC

authorization_code_flow_enabledboolean required

Determines whether Custom OIDC Authorization code flow is enabled or not. Set false if you intend to disable Custom OIDC

client_idstring

Client ID. This parameter is not required if the purpose of the request is to disable Custom OIDC but required if the Custom OIDC Authorization Code Flow is enabled.

client_secretstring

Client secret. This parameter is optional if the request aims to disable Custom OIDC but required if the Custom OIDC Authorization Code Flow is enabled.

metadata_urlstring required

Custom OIDC metadata URL. Set empty string if you intend to disable Custom OIDC

authorization_scopesstring

Authorization scopes. If not provided, default scopes will be used. Default scopes: openid email profile offline_access groups . This parameter is not required if the purpose of the request is to disable Custom OIDC

user_roles_claimstring

User roles claim. If not provided, the default claim will be used. Default claim: roles . This parameter is not required if the purpose of the request is to disable Custom OIDC

user_display_name_claimstring

User display name claim. If not provided, the default claim will be used. Default claim: preferred_username . This parameter is not required if the purpose of the request is to disable Custom OIDC

is_issuer_validation_enabledboolean

Determines whether issuer validation is enabled or not. This parameter is not required if the purpose of the request is to disable Custom OIDC

groups_mapping_typestring

Groups mapping type. This parameter is not required if the purpose of the request is to disable Custom OIDC

groups_mapping_rulesobject

Groups mapping rules. Required if groups_mapping_type is custom . This parameter is not required if the purpose of the request is to disable Custom OIDC

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.