Issue an API grant
post
/apiplatform/management/v1/apis/{apiId}/grants
Issue a grant to a user or group for the {apiId}
API.
The user requesting this resource must be assigned the API Manager role and must be issued the Manage API grant for the specified API.
Request
Supported Media Types
- application/json
Path Parameters
-
apiId: string
A unique ID referencing a specific API.
Root Schema : CreateGrantRequest
Type:
Show Source
object
-
group(optional):
object group
-
type(optional):
string
The grant type's name.
-
user(optional):
object user
Response
Supported Media Types
- application/json
204 Response
The grants were created.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
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
Unexpected error.
Root Schema : Error
Type:
Show Source
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 an API grant 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 @api-grant.json
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.
Example of Request Body
The following shows an example of the request body, included with the request above in a file named api-grant.json
.
{"type":"ManageAPIGrant","user":{"id":"api-manager-user"}}
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 17 Mar 2017 05:08:01 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002a7b8 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0