Get grants issued for an API
/apiplatform/management/v1/apis/{apiId}/grants
Returns a collection of grants that have been issued for the {apiId}
. By default, the grant type, role, and user or group ID for users or groups issued each grant are returned. Additional fields can be returned by sending any of these field names, separated by commas, in the fields query parameter: createdAt
, createdBy
, user.roles
, and group.roles
.
The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Manage API or View All Details grant for the specified API.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
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. - links(optional): array
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
createdAt(optional):
string
The date and time the grant was issued.
-
createdBy(optional):
string
The user who issued the grant.
-
group(optional):
object Group
-
type:
string
The grant type's name.
-
user(optional):
object User
object
-
links(optional):
array links
Includes 'canonical'.
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 a collection of grants issued for a specific API in Oracle API Platform Cloud Service - Classic by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET -u apicsadmin:password https://example.com/apiplatform/management/v1/apis/{apiId}/grants
-
{apiId}
is the unique Id for an API. To retrieve available API Ids, see Get APIs.
You can pass the following optional field values in the fields
query parameter, separated by commas, to include them in the response:
-
createdAt
: The date and time the grant was issued. -
createdBy
: The user who issued the grant. -
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 -u apicsadmin:password https://example.com/apiplatform/management/v1/apis/{apiId}/grants?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 18:21:02 GMT Content-length: 2031 Content-type: application/json X-oracle-dms-ecid: DJczQ0npR00000000 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 grants issued for the API and HATEOAS links to related operations.
{ "count": 1, "links": [ { "templated": "true", "method": "GET", "rel": "grantees", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ManageAPIGrant/grantees", "grant": "ManageAPIGrant" }, { "templated": "true", "method": "GET", "rel": "grantees", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ViewAllDetailsAPIGrant/grantees", "grant": "ViewAllDetailsAPIGrant" }, { "templated": "true", "method": "GET", "rel": "grantees", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/DeployAPIGrant/grantees", "grant": "DeployAPIGrant" }, { "templated": "true", "method": "GET", "rel": "grantees", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ViewPublicDetailsAPIGrant/grantees", "grant": "ViewPublicDetailsAPIGrant" }, { "templated": "true", "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants" }, { "method": "GET", "rel": "types", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/types" }, { "templated": "true", "method": "POST", "rel": "create", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants", "grant": "ManageAPIGrant" }, { "templated": "true", "method": "POST", "rel": "create", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants", "grant": "ViewAllDetailsAPIGrant" }, { "templated": "true", "method": "POST", "rel": "create", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants", "grant": "DeployAPIGrant" }, { "templated": "true", "method": "POST", "rel": "create", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants", "grant": "ViewPublicDetailsAPIGrant" } ], "items": [ { "links": [ { "templated": "true", "method": "DELETE", "rel": "delete", "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants/ManageAPIGrant/users/apicsadmin" } ], "type": "ManageAPIGrant", "user": { "roles": [ "Administrator" ], "id": "apicsadmin" } } ] }