...
| 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 |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Consumes Content-Type | n/a |
Example Responses | |
Read an OAuth Client: Query Parameters
The following request parameters will be needed for the service.
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|
oauthclientname
| N/A | Name used within the Controller to identify the OAuth Client. | String; URI parameter | Y (unless oauthclientid is specified) | oauthclientid
|
oauthclientid
| N/A | ID used within the Controller to identify the OAuth Client. | String; URI parameter | Y (unless oauthclientname is specified) | oauthclientname
|
Read an OAuth Client: XML and JSON Examples
| XML | JSON |
---|
Example Response | Expand |
---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<oauthClient exportReleaseLevel="7.3.0.0" exportTable="ops_oauth_client" retainSysIds="true" version="5">
<authorizationEndpoint>https://accounts.google.com/o/oauth2/v2/auth</authorizationEndpoint>
<clientId>client_id</clientId>
<clusterRedirectUrls>
<clusterRedirectUrl>
<clusterNode>asus-pc:8080-uc</clusterNode>
<redirectUrl>http://localhost:8180/uc/oauth2/callback</redirectUrl>
</clusterRedirectUrl>
</clusterRedirectUrls>
<description>description</description>
<name>Google</name>
<opswiseGroups/>
<provider>Google</provider>
<scopes>
<scope>https://mail.google.com</scope>
</scopes>
<sysId>239119555c2c427f8f5b29faeecfdc27</sysId>
<tokenEndpoint>https://oauth2.googleapis.com/token</tokenEndpoint>
</oauthClient>
|
| Expand |
---|
| {
"authorizationEndpoint": "https://accounts.google.com/o/oauth2/v2/auth",
"clientId": "client_id",
"clusterRedirectUrls": [
{
"clusterNode": "node1:8080-uc",
"redirectUrl": "http://localhost:8080/uc/oauth2/callback"
}
],
"description": "description",
"exportReleaseLevel": "7.3.0.0",
"exportTable": "ops_oauth_client",
"name": "Google",
"opswiseGroups": [],
"provider": "Google",
"retainSysIds": true,
"scopes": [
"https://mail.google.com"
],
"sysId": "239119555c2c427f8f5b29faeecfdc27",
"tokenEndpoint": "https://oauth2.googleapis.com/token",
"version": 5
}
|
|
---|
Delete an OAuth Client
Delete an OAuth Client: Query Parameters
The following request parameters will be needed for the service.
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|
oauthclientname
| N/A | Name used within the Controller to identify the OAuth Client. | String; URI parameter | Y (unless oauthclientid is specified) | oauthclientid
|
oauthclientid
| N/A | ID used within the Controller to identify the OAuth Client. | String; URI parameter | Y (unless oauthclientname is specified) | oauthclientname
|
List OAuth Clients
| Description |
---|
URI | http://host_name/uc/resources/oauthclient/list |
HTTP Method | GET |
Description | Retrieves information for all OAuth Clients. |
Example URI | http://localhost:8080/uc/resources/oauthclient/list |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Consumes Content-Type | n/a |
Example Responses | |
List an OAuth Client: XML and JSON Examples
XML | JSON |
---|
Expand |
---|
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<oauthClients>
<oauthClient exportReleaseLevel="7.3.0.0" exportTable="ops_oauth_client" version="5">
<authorizationEndpoint>https://accounts.google.com/o/oauth2/v2/auth</authorizationEndpoint>
<clientId>client_id</clientId>
<clusterRedirectUrls>
<clusterRedirectUrl>
<clusterNode>node1:8080-uc</clusterNode>
<redirectUrl>http://localhost:8080/uc/oauth2/callback</redirectUrl>
</clusterRedirectUrl>
</clusterRedirectUrls>
<description>description</description>
<name>Google</name>
<opswiseGroups/>
<provider>Google</provider>
<scopes>
<scope>https://mail.google.com</scope>
</scopes>
<sysId>239119555c2c427f8f5b29faeecfdc27</sysId>
<tokenEndpoint>https://oauth2.googleapis.com/token</tokenEndpoint>
</oauthClient>
</oauthClients>
|
| Expand |
---|
| [
{
"authorizationEndpoint": "https://accounts.google.com/o/oauth2/v2/auth",
"clientId": "client_id",
"clusterRedirectUrls": [
{
"clusterNode": "node1:8080-uc",
"redirectUrl": "http://localhost:8080/uc/oauth2/callback"
}
],
"description": "description",
"exportReleaseLevel": "7.3.0.0",
"exportTable": "ops_oauth_client",
"name": "Google",
"opswiseGroups": [],
"provider": "Google",
"scopes": [
"https://mail.google.com"
],
"sysId": "239119555c2c427f8f5b29faeecfdc27",
"tokenEndpoint": "https://oauth2.googleapis.com/token",
"version": 5
},
]
|
|