Oidc (Section)#

Path: /profiles/profile{id, type}/settings/authentication-service/authenticators/authenticator{id}/oidc

OpenID Connect methods

Parameters#

NameTypeRequiredDefaultDescription
configuration-urlurirequiredThe url to the openid-configuration document at theOpenID server (must end in ‘/.well-known/openid-configuration’)
client-idstringrequiredThe client-id, registered at the OpenID server
use-http-basic-authenticationbooleanoptionalfalseSend the client credentials using HTTP Basic authentication. When false, the credentials are sent in the request-body
scopestringoptionalopenidScope to ask the OpenID server for, space separated
clock-skewuint32optional60The allowed clock-skew in seconds when validating the JWT from the OpenID Server
authentication-context-class-referencenon-empty-stringoptionalThe Authentication Context Class Reference (ACR) or authentication method that should be sent in the request to the OpenID Server
http-clientleafrefoptionalA reference to the Http Client to use. If not defined, the default HTTP client is used
use-subject-for-login-hintbooleanoptionalfalseIf there is a previously authenticated subject, pass the subject as login_hint to the OpenID Server.
prompt-loginenumerationoptionalSetting controlling sending of prompt=login parameter. By default, it is not sent.
redirect-uri-overrideurioptionalAn optional override of the redirect URI that will be used in the authorization requests. The OP will redirect to this URI, however the actual redirect URI of this authenticator will remain unchanged. This means that the authorization response has to be relayed to the actual redirect URI of this authenticator.

Subsections#

NameTypeDescription
client-authentication-method OneOfNone
encrypted-id-token SectionID Token is expected to be encrypted
fetch-userinfo SectionFetch claims from the userinfo endpoint
parameter-mappings SectionNone

Was this helpful?