Get gateway grants
/apiplatform/management/v1/gateways/grants/types
Returns the grants that can be issued for gateways. The name, description, and ID of each grant is returned in the response.
Users requesting this resource must be assigned the Gateway 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 gateways in Oracle API Platform Cloud Service 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/gateways/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:49:56 GMT Content-length: 994 Content-type: application/json X-oracle-dms-ecid: XoN0n1ZtR00000000 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 gateways grants and HATEOAS links to related operations.
{ "count": 5, "links": [ { "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/gateways/grants/types" } ], "items": [ { "name": "Manage Gateway", "description": "Users issued this grant are allowed to manage API deployments to this gateway and manage the gateway itself.", "id": "ManageGatewayGrant" }, { "name": "View all details", "description": "Users issued this grant are allowed to view all information about this gateway.", "id": "ViewGatewayGrant" }, { "name": "Deploy to Gateway", "description": "Users issued this grant are allowed to deploy or undeploy APIs to this gateway.", "id": "DeployAPIToGatewayGrant" }, { "name": "Request Deployment to Gateway", "description": "Users issued this grant are allowed to request API deployments to this gateway.", "id": "RequestDeployAPIToGatewayGrant" }, { "name": "Node service account", "description": "Gateway Runtime service accounts are issued this grant to allow them to download configuration and upload statistics.", "id": "ServiceGatewayGrant" } ] }