GET oauth/admin/clients

Returns information about clients. For the provider admin, this operation returns a list of all client apps that have at least one grant; for the resource owner, it returns only the clients for which the resource owner has a grant.

Authorization Roles/Permissions: Must be the resource owner or provider admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{oauth-provider-url}/oauth/admin/clients

Sample Request

The example below shows a request for client information for the OAuth Provider.

Sample Request URL

https://{oauth-provider-url}/oauth/admin/clients

Sample request headers

Accept: application/xml
Cookie: OAuthToken_{OAuthProviderName}={Cookie value (usually starts with TokenID)}

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json
Cookie	OAuthToken_{OAuthProviderName}—The OAuth cookie that identifies the logged-in user with the provider. Depending on the operation being used and the context, the authenticated user could be the resource owner, the administrator, the client app administration, or the OAuth Provider. The cookie is returned after logging in with the POST /oauth/login operation.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
IncludeClientsWithActiveGrants	Query	Boolean	Optional	Indicates whether clients with active grants should be included in the results. Default: true.
includeClientsWithExpiredGrants	Query	Boolean	Optional	Indicates whether clients with expired grants should be included in the results. Default: true.
SortBy	Query	string	Optional	An optional parameter allowing users to sort results by a specific value; for example, com.soa.sort.order.updated sorts with the most updated entries first. For valid values, see Sort By Values. If not specified, items are returned in the sort order of DescendingDate, which means that the most recent items are first.
StartIndex	Query	int	Optional	An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result.
Count	Query	int	Optional	The number of results to be returned, from the specified starting point. If not specified, all matching results are returned.

Response

If successful, this operation returns HTTP status code 200, with the client information.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<rss xmlns:ns2="http://soa.com/xsd/rss/1.0" xmlns:ns3="http://soa.com/xsd/oauth/1.0" xmlns:ns4="http://soa.com/binding/http" version="1.0"> 
<channel> 
  <title>Clients</title> 
  <description>Clients either have active grants or expired grants with the Oauth Provider</description> 
  <item> 
     <title></title> 
     <guid>open-13MqsHYGZs7U75kJokqRv4vl</guid> 
     <ns3:GrantClient> 
      <ns3:ClientID>open-13MqsHYGZs7U75kJokqRv4vl</ns3:ClientID> 
     </ns3:GrantClient>
  </item> 
  <item> 
     <title></title>
     <guid>open-5ONp6iEvB9W1pAuemIyxnE9Q</guid> 
     <ns3:GrantClient> 
      <ns3:ClientID>open-5ONp6iEvB9W1pAuemIyxnE9Q</ns3:ClientID> 
     </ns3:GrantClient> 
  </item>  
</channel> 
</rss>

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json

Response Body

Name	Type	Description
RSS feed	RSS feed	The response is an RSS feed with one RSS item for each client ID. The only property available for each client is client-id.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the OAuthToken_{OAuthProviderName} cookie, or if you included an invalid cookie.
500	An error occurred processing the call.

More information about Akana OAuth API error messages.

Related Topics