Cloudentity Application Service

description
optional

Scope description
Example : "read access"

string

name
required

Scope name
Example : "read"

string

accessTokenValiditySeconds
optional

Access token validity time in seconds

integer

allowIntrospection
optional

Determines if client can make calls to introspection endpoint

boolean

applicationType
optional

Type of OAuth Client application.
Example : "web"

enum (native, web, spa, cli)

clientDescription
optional

Client description

string

clientId
required

Generated identifier of created OAuth client
Example : "370e7f5f-473c-41ef-8639-d362b068bb67"

string

clientName
optional

Name of OAuht client
Example : "sample app"

string

contacts
optional

OAuth client contacts

< string > array

defaultMaxAge
optional

Default maximum session age before re-prompting

integer

deviceCodeValiditySeconds
optional

Device code validity seconds

integer

grantTypes
optional

OAuth grant types. Supported values ["refresh_token", "authorization_code"]

< string > array

idTokenValiditySeconds
optional

id_token validity time in seconds

integer

logoUri
optional

URL of the logo

string

redirectUris
optional

OAuth redirect uris

< string > array

refreshTokenValiditySeconds
optional

Refresh token validity time in seconds

integer

requireAuthTime
optional

Always require that the auth_time claim be sent in the id token

boolean

reuseRefreshToken
optional

Reuse refresh tokens if they are not time

boolean

scope
optional

OAuth client scopes

< string > array

subjectType
optional

Access type parameter
Example : "PUBLIC"

string

tokenEndpointAuthMethod
optional

Authorization method. Possible values ["SECRET_POST", "SECRET_BASIC", "SECRET_JWT", "PRIVATE_KEY", "NONE"] SECRET_BASIC value is by default.
Example : "SECRET_BASIC"

string

tosUri
optional

URL for the Terms of Service of this client, will be displayed to the user

string

grantTypes
optional

OAuth grant types

< string > array

scope
optional

OAuth client scopes

< string > array

message
optional

Description of status if available

string

appId
optional

appId

string

permissions
optional

< permissions > array

prefix
optional

Permission name with prefix
Example : "cloudentity::list_devices"

string

description
optional

Permission description
Example : "Email scope description"

string

name
optional

Permission name
Example : "email"

string

capabilities
required

Names of capabilities used in application
Example : "[ \"oauth\" ]"

< string > array

customer
required

Id of the customer that application belongs to
Example : "c4a49b60-aced-11e7-abc4-cec278b6b50a"

string

description
optional

Description of application

string

id
required

Unique identifier of created application
Example : "a4a49b60-aced-11e7-abc4-cec278b6b50a"

string

isSystem
required

True if application is default Resource Server

boolean

name
required

Name of application
Example : "My app"

string

owner
required

Id of the owner that application belongs to
Example : "b4a49b60-aced-11e7-abc4-cec278b6b50a"

string

uuid
required

Unique identifier of created application
Example : "a4a49b60-aced-11e7-abc4-cec278b6b50a"

string

appId
optional

Identifier of application

string

microserviceId
optional

Identifier of microservice

string

applicationMicroservices
optional

< applicationMicroservices > array

appId
optional

Identifier of application

string

microserviceId
optional

Identifier of microservice

string

applicationType
optional

Application type
Example : "web"

string

applications
optional

< applications > array

capabilities
required

Names of capabilities used in application
Example : "[ \"oauth\" ]"

< string > array

customer
required

Id of the customer that application belongs to
Example : "c4a49b60-aced-11e7-abc4-cec278b6b50a"

string

description
optional

Description of application

string

id
required

Unique identifier of created application
Example : "a4a49b60-aced-11e7-abc4-cec278b6b50a"

string

isSystem
required

True if application is default Resource Server

boolean

name
required

Name of application
Example : "My app"

string

owner
required

Id of the owner that application belongs to
Example : "b4a49b60-aced-11e7-abc4-cec278b6b50a"

string

description
optional

Description of application

string

name
required

Name of application

string

description
optional

Description of permission

string

name
required

Name of permission. Only [A-Za-z0-9-_]+ characters are allowed.

string

description
optional

string

name
required

string

appId
required

string

prefix
required

string

scopes
required

< scopes > array

description
optional

string

name
required

string

scopes
required

< scopes > array

appId
required

string

prefix
required

string

scopes
required

< scopes > array

description
optional

string

name
required

string

code
optional

Unique internal error code

string

details
optional

Optional details

object

message
optional

Description of the error code

string

description
optional

Description of application

string

grantTypes
required

OAuth client grant types

< string > array

name
required

Name of application

string

redirectUris
required

OAuth client redirect uris

< string > array

scopes
required

OAuth client scopes

< string > array

uuid
optional

Unique identifier of application

string

description
optional

Description of application

string

name
required

Name of application

string

prefix
optional

Resource Server prefix

string

scopes
required

< scopes > array

uuid
required

Unique identifier of application

string

description
optional

Permission description

string

externalId
optional

Permission external id

string

name
required

Permission name

string

policy
optional

Authz policy

string

prefix
optional

Permission prefix

string

description
optional

Permission description

string

externalId
optional

Permission external id

string

name
required

Permission name

string

policy
optional

Authz policy

string

prefix
optional

Permission prefix

string

content
optional

content

customer
optional

Customer id of authenticated user

string

uuid
optional

Uuid of authenticated user

string

permissions
required

Example : [ "WRITE", "READ", "CREATE" ]

< string > array

appId
optional

Unique identifier of created application
Example : "a4a49b60-aced-11e7-abc4-cec278b6b50a"

string

microserviceId
optional

Microservice identifier
Example : "card-service"

string

id
required

Identifier of microservice

string

accessTokenValiditySeconds
optional

Access token validity time in seconds

integer

allowIntrospection
optional

Determines if client can make calls to introspection endpoint

boolean

clientDescription
optional

Client description

string

clientId
required

Generated identifier of created OAuth client
Example : "370e7f5f-473c-41ef-8639-d362b068bb67"

string

clientName
optional

Name of OAuht client
Example : "sample app"

string

clientSecret
required

OAuth client secret. If not provided then will be generated
Example : "AM0ubrG0snYtavs81pKdI14JWw34ptedRarSh0Skr5-kReggXIRiuLYXCG3Lg3339Bil4BVRnxw4EQC_G7jDGhA"

string

contacts
optional

OAuth client contacts

< string > array

defaultMaxAge
optional

Default maximum session age before re-prompting

integer

deviceCodeValiditySeconds
optional

Device code validity seconds

integer

grantTypes
optional

OAuth grant types. Supported values ["refresh_token", "authorization_code"]

< string > array

id
required

Internal OIDC unique identifier of OAuth client
Example : 1

integer

idTokenValiditySeconds
optional

id_token validity time in seconds

integer

logoUri
optional

URL of the logo

string

redirectUris
optional

OAuth redirect uris

< string > array

refreshTokenValiditySeconds
optional

Refresh token validity time in seconds

integer

requireAuthTime
optional

Always require that the auth_time claim be sent in the id token

boolean

reuseRefreshToken
optional

Reuse refresh tokens if they are not time out

boolean

scope
optional

OAuth client scopes

< string > array

subjectType
optional

Access type parameter
Example : "PUBLIC"

string

tokenEndpointAuthMethod
optional

Authorization method. Possible values ["SECRET_POST", "SECRET_BASIC", "SECRET_JWT", "PRIVATE_KEY", "NONE"] SECRET_BASIC value is by default.
Example : "SECRET_BASIC"

string

tosUri
optional

URL for the Terms of Service of this client, will be displayed to the user

string

accessTokenValiditySeconds
optional

Access token validity time in seconds

integer

allowIntrospection
optional

Determines if client can make calls to introspection endpoint

boolean

applicationType
optional

Type of OAuth Client application.
Example : "web"

enum (native, web, spa, cli)

clientDescription
optional

Client description

string

clientId
required

Generated identifier of created OAuth client
Example : "370e7f5f-473c-41ef-8639-d362b068bb67"

string

clientName
optional

Name of OAuht client
Example : "sample app"

string