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

40169ccdec5c

o-auth-2-controller

Save OAuth2 Client (saveOAuth2Client)

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

post/api/oauth2/client

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

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

Oauth2 client title

clientIdstring required

OAuth2 client ID. Cannot be empty

clientSecretstring required

OAuth2 client secret. Cannot be empty

authorizationUristring required

Authorization URI of the OAuth2 provider. Cannot be empty

accessTokenUristring required

Access token URI of the OAuth2 provider. Cannot be empty

scopestring[] required

OAuth scopes that will be requested from OAuth2 platform. Cannot be empty

userInfoUristring

User info URI of the OAuth2 provider

userNameAttributeNamestring required

Name of the username attribute in OAuth2 provider response. Cannot be empty

jwkSetUristring

JSON Web Key URI of the OAuth2 provider

clientAuthenticationMethodstring required

Client authentication method to use: 'BASIC' or 'POST'. Cannot be empty

loginButtonLabelstring required

OAuth2 provider label. Cannot be empty

loginButtonIconstring

Log in button icon for OAuth2 provider

platformsstring[]

List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)

namestring

Example request

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

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

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

Oauth2 client title

clientIdstring required

OAuth2 client ID. Cannot be empty

clientSecretstring required

OAuth2 client secret. Cannot be empty

authorizationUristring required

Authorization URI of the OAuth2 provider. Cannot be empty

accessTokenUristring required

Access token URI of the OAuth2 provider. Cannot be empty

scopestring[] required

OAuth scopes that will be requested from OAuth2 platform. Cannot be empty

userInfoUristring

User info URI of the OAuth2 provider

userNameAttributeNamestring required

Name of the username attribute in OAuth2 provider response. Cannot be empty

jwkSetUristring

JSON Web Key URI of the OAuth2 provider

clientAuthenticationMethodstring required

Client authentication method to use: 'BASIC' or 'POST'. Cannot be empty

loginButtonLabelstring required

OAuth2 provider label. Cannot be empty

loginButtonIconstring

Log in button icon for OAuth2 provider

platformsstring[]

List of platforms for which usage of the OAuth2 client is allowed (empty for all allowed)

namestring

Example response

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