OPProfileConfiguration-ClientAuthentication

OPProfileConfiguration-ClientAuthentication

Options common to OP profiles that support client authentication:

Name

Type

Default

Description

Name

Type

Default

Description

tokenEndpointAuthMethods

Collection<String>

client_secret_basic,
client_secret_post,
client_secret_jwt,
private_key_jwt

Enabled endpoint client authentication methods for the profile. Note that the RP metadata also needs to set the token endpoint authentication method: the default value when it’s not set is client_secret_basic.

Also note that the method none for public clients that cannot authenticate is not included in the list of default values. Similarly to other methods, it needs to be enabled in the profile with this option and also set in the RP metadata.

useTargetedEndpointAsJWTAudience4.3

Boolean

true

Flag to enable use of endpoints (the token or target endpoint) in the JWT client authentication audience

requireSingleJWTAudience4.3

Boolean

false

Flag to require single value in the JWT client authentication audience

clientAuthenticationJWTType4.3

String

 

Mandatory value for the typ header used within JWT authentication

unregisteredClientPolicy4.0

Map<String, UnregisteredClientPolicy>

See wiki page

The policy used to verify unverified clients when this profile is enabled in the unverified RP config

Since OP v3.4, the JWT-based client authentication methods (client_secret_jwt and private_key_jwt) accepts any of the following three audiences:

  1. OP issuer value (profile responder ID)

  2. The token flow endpoint URL value (even for introspection and revocation endpoints)

  3. The flow endpoint URL value

For convenience, the following methods also exist for globally control the default values:

  • Property idp.oauth2.jwtAuth.targetedEndpointAsJWTAudience4.3

  • Property idp.oauth2.jwtAuth.requireSingleJWTAudience4.3

  • Any custom bean for validating the audience can be set via idp.oauth2.jwtAuth.audienceValidator -property.

For convenience, the enabled client authentication methods are also controllable globally via the idp.oidc.tokenEndpointAuthMethods property.