Universal Controller supports the following RESTful-based web services for OAuth Single Sign-On Settings, which are listed alphabetically on this page.
- Read OAuth Single Sign-On Settings
Update OAuth Single Sign-On Settings
Formatting specifications for each web service, including details about parameter requirements, are provided.
Read OAuth Single Sign-On Settings
Description | |
---|---|
URI | http://host_name/uc/resources/oauthsettings |
HTTP Method | PUT |
Description | Update the OAuth Single Sign-On Settings. |
Example URI | |
Authentication | Required |
Produces Content-Type | text/plain |
Consumes Content-Type | application/xml, application/json |
Example Responses |
|
Read OAuth Single Sign-On Settings: XML and JSON Responses
XML | JSON |
---|---|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <oauthSettings exportReleaseLevel="7.7.0.0" exportTable="ops_oauth_settings"> <attrActive /> <attrDepartment /> <attrEmail>email</attrEmail> <attrFirstName>given_name</attrFirstName> <attrGroups>groups</attrGroups> <attrHomePhone /> <attrLastName>family_name</attrLastName> <attrManager /> <attrMiddleName /> <attrMobilePhone /> <attrPhone /> <attrTitle /> <clientId>0oa22oyww...NIS0h8</clientId> <clusterBaseRedirectUrls> <clusterBaseRedirectUrl> <baseRedirectUrl>http://example.com:8080/uc</baseRedirectUrl> <clusterNode>example.com:8080-uc</clusterNode> </clusterBaseRedirectUrl> </clusterBaseRedirectUrls> <issuerUri>https://{accountId}.oktapreview.com/oauth2/default</issuerUri> <jwtAudienceClaimValue>api://default</jwtAudienceClaimValue> <jwtJwkSetUri /> <opaqueIntrospectionUri /> <pkce>true</pkce> <scopes> <scope>openid</scope> <scope>profile</scope> <scope>email</scope> </scopes> <selfServiceClientId>0oa22oz08...9O50h8</selfServiceClientId> <singleSignOn>true</singleSignOn> <sysId>78c1fcdd9df446fb82c0bd74bfb0697e</sysId> <tokenValidation>JWT</tokenValidation> <userNameClaimName>uc_username</userNameClaimName> <userProvisioning> <userProvisioningOption>Web Browser Access</userProvisioningOption> <userProvisioningOption>Web Service Access</userProvisioningOption> </userProvisioning> </oauthSettings> | { "attrActive": null, "attrDepartment": null, "attrEmail": "email", "attrFirstName": "given_name", "attrGroups": "groups", "attrHomePhone": null, "attrLastName": "family_name", "attrManager": null, "attrMiddleName": null, "attrMobilePhone": null, "attrPhone": null, "attrTitle": null, "clientId": "0oa22oyww...NIS0h8", "clusterBaseRedirectUrls": [ { "baseRedirectUrl": "http://example.com:8080/uc", "clusterNode": "example.com:8080-uc" } ], "exportReleaseLevel": "7.7.0.0", "exportTable": "ops_oauth_settings", "issuerUri": "https://{accountId}.oktapreview.com/oauth2/default", "jwtAudienceClaimValue": "api://default", "jwtJwkSetUri": null, "opaqueIntrospectionUri": "https://{accountId}.oktapreview.com/oauth2/default", "pkce": true, "scopes": [ "openid", "profile", "email" ], "selfServiceClientId": "0oa22oz08...9O50h8", "singleSignOn": true, "sysId": "78c1fcdd9df446fb82c0bd74bfb0697e", "tokenValidation": "JWT", "userNameClaimName": "uc_username", "userProvisioning": [ "Web Browser Access", "Web Service Access" ] } |
Update OAuth Single Sign-On Settings
Description | |
---|---|
URI | http://host_name/uc/resources/oauthsettings |
HTTP Method | PUT |
Description | Update the OAuth Single Sign-On Settings. |
Example URI | |
Authentication | Required |
Produces Content-Type | text/plain |
Consumes Content-Type | application/xml, application/json |
Example Responses |
|
Update OAuth Single Sign-On Settings: Payload Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| OAuth Single Sign-On | If true, turns on OAuth Single Sign-On. If false, turns off OAuth Single Sign-On. | Boolean; Valid values: true/false. Default is false. | N |
| User Provisioning | N | ||
| Issuer URI | Must be a valid URL beginning with http://, or https:// and contain no spaces. | Y (if | |
| Client Id | Y (if | ||
| Client Secret | The | Y (if | |
| Scopes | XML JSON | N | |
| User Id (Username) Claim Name | N | ||
| Proof Key for Code Exchange (PKCE) | Boolean; Valid values: true/false. Default is false. | N | |
| Cluster Node Base Redirect URLs | N | ||
| OAuth Bearer Token Validation | Valid values (case-insensitive):
| N | |
| Introspection URI | Must be a valid URL beginning with http://, or https:// and contain no spaces. | Y (if | |
| JWK Set URI | Must be a valid URL beginning with http://, or https:// and contain no spaces. | N | |
| Audience Claim Value | N | ||
| First Name | Y (if | ||
| Middle Name | N | ||
| Last Name | N | ||
| N | |||
| Title | N | ||
| Department | N | ||
| Manager | N | ||
| Business Phone | N | ||
| Mobile Phone | N | ||
| Home Phone | N | ||
| Active | N | ||
| Groups | N | ||
| Self Service Client Id | N |