Get eligible grantees
/apiplatform/management/v1/apis/grants/{grantType}/grantees
Returns users and groups in the identity management system who are eligible to receive the {grantType}
API grant. By default, the role and ID of each eligible account is returned. Additional fields can be returned by sending any of these field names, separated by commas, in the fields query parameter: user.roles
and group.roles
.
Users requesting this resource must be assigned the API Manager role.
Request
- application/json
-
grantType: string
The grant type.
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to retrieve the users and groups that are eligible to receive an API grant by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/grants/{grantType}/grantees
{grantType}
is the type of grant. To retrieve available grants that can be issued for APIs. see Get API grants.
You can pass the following optional field values in the fields
query parameter, separated by commas, to include them in the response:
-
user.roles
: The roles the user is assigned. -
group.roles
: The roles the group is assigned.
The following example shows you how to include these fields in the response:
curl -i -X GET
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/grants/{grantType}/grantees?fields=user.roles,group.roles
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 02 Jan 2017 19:20:50 GMT Content-length: 553 Content-type: application/json X-oracle-dms-ecid: Ej84G0ZHZ00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the name, description, and ID of the users and groups that are eligible to receive the specified grant.
{ "count": 8, "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ManageAPIGrant/grantees" } ], "items": [ { "user": { "roles": [ "ApplicationDeveloper", "APIManager" ], "id": "app-dev-user" } }, { "user": { "roles": [ "Administrator" ], "id": "api-admin-user2" } }, { "user": { "roles": [ "APIManager" ], "id": "api-manager-user2" } }, { "user": { "roles": [ "Administrator" ], "id": "weblogic" } }, { "user": { "roles": [ "Administrator" ], "id": "api-admin-user" } }, { "user": { "roles": [ "GatewayRuntime", "APIManager" ], "id": "api-manager-user" } }, { "group": { "roles": [ "APIManager" ], "id": "APIManagers" } }, { "group": { "roles": [ "Administrator" ], "id": "APICSAdministrators" } } ] }