Get API grants
/apiplatform/management/v1/apis/grants/types
Returns the grants that can be issued for APIs. The name, description, and ID of each grant is returned in the response.
Users requesting this resource must be assigned the API Manager role.
Request
There are no request parameters for this operation.
Back to TopResponse
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
description(optional):
string
-
id:
string
The grant type's ID.
-
name(optional):
string
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 grants that can be issued for APIs 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/types
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:36:27 GMT Content-length: 930 Content-type: application/json X-oracle-dms-ecid: N_EsF0k2S00000000 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 available API grants and HATEOAS links to related operations.
{ "count": 4, "links": [ { "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/apis/grants/types" } ], "items": [ { "name": "Manage API", "description": "Users issued this grant are allowed to modify the definition of and issue grants for this API.", "id": "ManageAPIGrant" }, { "name": "View all details", "description": "Users issued this grant are allowed to view all information about this API in the Management Portal.", "id": "ViewAllDetailsAPIGrant" }, { "name": "Deploy API", "description": "Users issued this grant are allowed to deploy or undeploy this API to a gateway for which they have deploy rights. This allows users to deploy this API without first receiving a request from an API Manager.", "id": "DeployAPIGrant" }, { "name": "View public details", "description": "Users issued this grant are allowed to view the publicly available details of this API on the Developer Portal.", "id": "ViewPublicDetailsAPIGrant" } ] }