Jump to

• Request
• Response
• Examples

Issue plan grants

post

/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

Supported Media Types

• application/json

Path Parameters

• planId: string
  A unique ID referencing a specific plan.

Body ()

Root Schema : CreateGrantRequest

Type: object

Show Source

• group(optional): object group
• type(optional): string
  The grant type's name.
• user(optional): object user

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The grant type's name."
        },
        "user":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The user's ID."
                }
            },
            "required":[
                "id"
            ]
        },
        "group":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The group's ID."
                }
            },
            "required":[
                "id"
            ]
        }
    }
}

Nested Schema : group

Type: object

Show Source

• id: string
  The group's ID.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The group's ID."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : user

Type: object

Show Source

• id: string
  The user's ID.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The user's ID."
        }
    },
    "required":[
        "id"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

The grants were created.

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

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 
-u apicsadmin:password
-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

Back to Top