Get plan grants
/apiplatform/management/v1/plans/grants/types
Returns the grants that can be issued for plans. 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 plans 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/plans/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 19:11:27 GMT Content-length: 474 Content-type: application/json X-oracle-dms-ecid: AR8Zh1gnR00000000 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 plan grants and HATEOAS links to related operations.
{ "count": 2, "links": [ { "method": "GET", "rel": "self", "href": "https://example.com:443/apiplatform/management/v1/plans/grants/types" } ], "items": [ { "name": "Register", "description": "Users issued this grant are allowed to register applications for this plan.", "id": "RegisterApplicationForPlanGrant" }, { "name": "Request registration", "description": "Users issued this grant are allowed to request to register applications for this plan.", "id": "RequestRegisterApplicationForPlanGrant" } ] }