REST API for the Management Service in Oracle API Platform Cloud Service

Get service grants

get

/apiplatform/management/v1/services/grants/types

Returns the grants that can be issued for services. The name, description, and ID of each grant is returned in the response.

Users requesting this resource must be assigned the Service Manager role.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

The collection of grant types

Root Schema : GetGrantTypesResponse

Match All

Show Source

object CollectionResponseFeature
object GetGrantTypesResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Type"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

count(optional): integer(int32)

The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : GetGrantTypesResponse-allOf[1]

Type: object

Show Source

items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Type"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Type"
    }
}

Nested Schema : Type

Type: object

Show Source

description(optional): string
id: string

The grant type's ID.
name(optional): string

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

403 Response

Forbidden.

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.

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"
    }
}

Examples

The following example shows how to retrieve the available service grants 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/services/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:  Tue, 10 Oct 2017 07:24:25 GMT
Content-Length:  865
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00018fc1
X-oracle-dms-rid:  0
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following shows an example of the response body, including the name, description, and ID of the grant.

{
    "count": 3,
    "links": [
        {
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/services/grants/types"
        }
    ],
    "items": [
        {
            "name": "Manage Service",
            "description": "Users issued this grant are allowed to modify and delete this service.",
            "id": "ManageServiceGrant"
        },
        {
            "name": "View all details",
            "description": "Users issued this grant are allowed to see all details about this service.",
            "id": "ViewAllDetailsServiceGrant"
        },
        {
            "name": "Reference Service",
            "description": "Users issued this grant are allowed to reference this service.",
            "id": "ReferenceServiceGrant"
        }
    ]
}