Overview
Universal Controller supports the following RESTful-based web services for OAuth Client operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about parameter requirements, are provided.
Create an OAuth Client
Description | |
---|---|
URI | http://host_name/uc/resources/oauthclient |
HTTP Method | POST |
Description | Creates an OAuth Client. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | n/a |
Consumes Content-Type | application/xml, application/json |
Example Responses |
|
OAuth Client Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Authorization Endpoint | The authorization endpoint for the authorization server. | Y | |
| Client ID | The Client ID issued by the authorization server. | Y | |
| 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 |
| Token Endpoint | The token endpoint for the authorization server. | Y |
Create an OAuth Client: XML and JSON Examples
XML | JSON | |
---|---|---|
Example Request |