Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

UI Field Name

Description

Specifications

Required

authorizationEndpoint

Authorization Endpoint

The authorization endpoint for the authorization server. Read only. 


Y

clientId

Client ID

The Client ID issued by the authorization server.


Y

clientSecret

Client Secret

The Client secret issued by the authorization server.


Y

clusterRedirectUrls

Cluster Node Redirect URLs

List of Redirect URLS.

XML

<clusterRedirectUrls>
    <clusterRedirectUrl>
        <clusterNode>node1:8080-uc</clusterNode>
        <redirectUrl>http://localhost:8080/uc/oauth2/callback</redirectUrl>
    </clusterRedirectUrl>
</clusterRedirectUrls>

JSON

"clusterRedirectUrls": [
    {
        "clusterNode": "node1:8080-uc",
        "redirectUrl": "http://localhost:8080/uc/oauth2/callback"
    }
]


N

description

Description

Description of this record.


N

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

exportTable

n/a

Record table information.

read only

N

name

Name

Name used within the Controller to identify this OAuth Client.

Maximum 100 alphanumerics.

Y

opswiseGroups

Member of Business Services

List of Business Services:
 
XML

<opswiseGroups>
	<opswiseGroup>test</opswiseGroup>
</opswiseGroups>

JSON

"opswiseGroups": [
    "test"
]


N

provider

Provider

The authentication server provider.

Note

The Provider property cannot be changed after the OAuth Client is created.

Valid Values:

  • As String = Azure AD, As Value = 1

  • As String = Google, As Value = 2

Y

retainSysIds

n/a

Specification for whether or not the Create an OAuth Client web service will persist the sysId property.

  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.

  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

In XML web services, retainSysIds is specified as an attribute in the <calendar> element.

Valid values: true/false (default is true).

N

scopes

Scopes

List of scopes to request access to.

XML

<scopes>
	<scope>https://mail.google.com</scope>
</scopes>

JSON

"scopes": [
    "https://mail.google.com"
]



Y

sysId

UUID

System ID field in the database for this OAuth Client record.

Persisted only if retainSysIds is set to true.

N

tenantIdTenant ID If provider is Azure AD; The tenant identifier. If not specified, defaults to common. 
N

tokenEndpoint

Token Endpoint

The token endpoint for the authorization server. Read only. 


Y

Create an OAuth Client: XML and JSON Examples 

...