...
Property | UI Field Name | Description | Specifications | Required | ||
---|---|---|---|---|---|---|
| Authorization Endpoint | The authorization endpoint for the authorization server. | Read only. | Y | ||
| Client ID | The Client ID issued by the authorization server. | YN | |||
| Client Secret | The Client secret issued by the authorization server. | Y | |||
| Cluster Node Redirect URLs | List of Redirect URLS. XML
JSON
| N | |||
| Description | Description of this record. | N | |||
| n/a | Universal Controller release that the record was exported from. | read only | N | ||
| n/a | Record table information. | read only | N | ||
| Name | Name used within the Controller to identify this OAuth Client. | Maximum 100 alphanumerics. | Y | ||
| Member of Business Services | List of Business Services:
JSON
| N | |||
| Provider | The authentication server provider.
| Valid Values:
| Y | ||
| n/a | Specification for whether or not the Create an OAuth Client web service will persist the sysId property.
Note In XML web services, | Valid values: true/false (default is true). | N | ||
| Scopes | List of scopes to request access to. XML
JSON
| Y | |||
| UUID | System ID field in the database for this OAuth Client record. | Persisted only if retainSysIds is set to true. | N | ||
tenantId | Tenant ID | If provider is Azure AD; The tenant identifier. If not specified, defaults to common. | N | |||
| Token Endpoint | The token endpoint for the authorization server.Y | Read only. | N |
Create an OAuth Client: XML and JSON Examples
XML | JSON | |||||
---|---|---|---|---|---|---|
Example Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
Modify an OAuth Client
Description
URI
|
Modify an OAuth Client
Description | |
---|---|
URI | http://host_name/uc/resources/oauthclient |
HTTP Method | PUT |
Description | Modifies an OAuth Client. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | n/a |
Consumes Content-Type | application/xml, application/json |
Example Responses |
|
Modify an OAuth Client: XML and JSON Examples
XML | JSON | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
|
Read an OAuth Client
Description | |
---|---|
URI | http://host_name/uc/resources/oauthclient |
HTTP Method | GET |
Description | Retrieves information for a specific OAuth Client. |
Example URI | http://localhost:8080/uc/resources/oauthclient?oauthclientname=testOAuthClient |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Consumes Content-Type | n/a |
Example Responses |
|
...
Read an OAuth Client: XML and JSON Examples
XML | JSON | |||||
---|---|---|---|---|---|---|
Example Response |
|
|
|
Delete an OAuth Client
Description | |
---|---|
URI | http://host_name/uc/resources/oauthclient |
HTTP Method | DELETE |
Description | Deletes an OAuth Client. |
Example URI | http://localhost:8080/uc/resources/oauthclient?oauthclientname=testOauthClient |
Authentication | HTTP Basic |
Produces Content-Type | n/a |
Consumes Content-Type | n/a |
Example Responses |
|
...
List an OAuth Client: XML and JSON Examples
XML | JSON | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Response |
|
|