Find OAuth Client by name or ID
get
/oam/services/rest/ssa/api/v1/oauthpolicyadmin/client
Returns an OAuth Client. The search can be done either with the name or the ID of the Client. Only one of the query parameters needs to be specified.
Request
Supported Media Types
- application/json
Query Parameters
-
id: string
ClientID of the client
-
identityDomainName: string
Name of the Identity Domain under which the Client exits
-
name: string
Name of the Client
Response
Supported Media Types
- application/json
200 Response
Sucessfully retrieved entity - OAuthClient, detail
Root Schema : Client
Type:
Show Source
object
-
attributes:
array attributes
-
clientType:
string
Allowed Values:
[ "CONFIDENTIAL_CLIENT", "PUBLIC_CLIENT", "MOBILE_CLIENT" ]
Type of the client -
description:
string
-
grantTypes:
array grantTypes
-
id:
string
ClientID for the client. Will be auto generated if not specified
-
idDomain:
string
Name of the Identity Domain under which the Client exists
-
name:
string
Name of the Client
-
redirectURIs:
array redirectURIs
-
scopes:
array scopes
-
secret:
string
Password for the client if confidential
Nested Schema : attributes
Type:
Show Source
array
-
[0]:
object TokenAttributeSettings
Custom attributes that can be added to the Access Token
Nested Schema : grantTypes
Type:
Show Source
array
-
[0]:
string
Allowed Values:
[ "PASSWORD", "REFRESH_TOKEN", "JWT_BEARER", "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ]
Nested Schema : TokenAttributeSettings
Type:
object
Custom attributes that can be added to the Access Token
Show Source
-
attrName:
string
Name of the custom attribute
-
attrType:
string
Allowed Values:
[ "STATIC", "DYNAMIC" ]
Type of the Attribute -
attrValue:
string
Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted.
Nested Schema : RedirectURI
Type:
Show Source
object
-
isHttps:
boolean
Default Value:
true
-
url:
string
Redirect URL
422 Response
Failed to retrive OAuth entity "Client" - name "NameofClient"