Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

o-auth-2-config-template-controller

Create or update OAuth2 client registration template (saveClientRegistrationTemplate) Available for users with 'SYS_ADMIN' authority.

Client registration template is OAuth2 provider configuration template with default settings for registering new OAuth2 clients

post/api/oauth2/config/template

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

providerIdstring required

OAuth2 provider identifier (e.g. its name)

authorizationUristring

Default authorization URI of the OAuth2 provider

accessTokenUristring

Default access token URI of the OAuth2 provider

scopestring[]

Default OAuth scopes that will be requested from OAuth2 platform

userInfoUristring

Default user info URI of the OAuth2 provider

userNameAttributeNamestring

Default name of the username attribute in OAuth2 provider log in response

jwkSetUristring

Default JSON Web Key URI of the OAuth2 provider

clientAuthenticationMethodstring

Default client authentication method to use: 'BASIC' or 'POST'

commentstring

Comment for OAuth2 provider

loginButtonIconstring

Default log in button icon for OAuth2 provider

loginButtonLabelstring

Default OAuth2 provider label

helpLinkstring

Help link for OAuth2 provider

namestring
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9"
  },
  "createdTime": 1746028547220,
  "mapperConfig": {
    "basic": {
      "tenantNamePattern": "%{email}"
    }
  },
  "additionalInfo": {}
}

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

providerIdstring required

OAuth2 provider identifier (e.g. its name)

authorizationUristring

Default authorization URI of the OAuth2 provider

accessTokenUristring

Default access token URI of the OAuth2 provider

scopestring[]

Default OAuth scopes that will be requested from OAuth2 platform

userInfoUristring

Default user info URI of the OAuth2 provider

userNameAttributeNamestring

Default name of the username attribute in OAuth2 provider log in response

jwkSetUristring

Default JSON Web Key URI of the OAuth2 provider

clientAuthenticationMethodstring

Default client authentication method to use: 'BASIC' or 'POST'

commentstring

Comment for OAuth2 provider

loginButtonIconstring

Default log in button icon for OAuth2 provider

loginButtonLabelstring

Default OAuth2 provider label

helpLinkstring

Help link for OAuth2 provider

namestring
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9"
  },
  "createdTime": 1746028547220,
  "mapperConfig": {
    "basic": {
      "tenantNamePattern": "%{email}"
    }
  },
  "additionalInfo": {}
}