Issue plan grants
/apiplatform/management/v1/plans/{planId}/grants
Issue a grant to a user or group for the {planId}
plan.
The user requesting this resource must be assigned the API Manager role and must be issued the Manage API grant for the API associated with the specified plan.
Request
- application/json
-
planId: string
A unique ID referencing a specific plan.
object
-
group(optional):
object group
-
type(optional):
string
The grant type's name.
-
user(optional):
object user
Response
- application/json
204 Response
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 issue a plan grant to a user or group by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @plan-grant.json
https://example.com/apiplatform/management/v1/plans/{planId}/grants
{planId}
is the unique Id for a plan. To retrieve available plan Ids, see Get plans.
Example of Request Body
The following example shows the contents of the request body in JSON format, included with the request above in a file named plan-grant.json
.
{ "type": "RegisterApplicationForPlanGrant", "user": { "id": "app-dev-user" } }
Example of Response Headers
The following shows an example of the response headers.
204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 17 Mar 2017 10:39:22 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002b89f X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0