Jump to

• Request
• Response
• Examples

Get grants issued for an API

get

/apiplatform/management/v1/apis/{apiId}/grants

Returns a collection of grants that have been issued for the {apiId}. By default, the grant type, role, and user or group ID for users or groups issued each grant are returned. Additional fields can be returned by sending any of these field names, separated by commas, in the fields query parameter: createdAt, createdBy, user.roles, and group.roles.

The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Manage API or View All Details grant for the specified API.

Request

Supported Media Types

• application/json

Path Parameters

• apiId: string
  A unique ID referencing a specific API.

Query Parameters

• fields(optional): array
  Collection Format: csv

  Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of grants

Body ()

Root Schema : GetGrantsResponse

Match All

Show Source

• object CollectionResponseFeature
• object LinksResponseFeature
• object GetGrantsResponse-allOf[2]

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

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 : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : GetGrantsResponse-allOf[2]

Type: object

Show Source

• items(optional): array items

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

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: GetGrantsItem

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

Nested Schema : GetGrantsItem

Match All

Show Source

• object Grant
• object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Grant"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Grant

Type: object

Show Source

• createdAt(optional): string
  The date and time the grant was issued.
• createdBy(optional): string
  The user who issued the grant.
• group(optional): object Group
• type: string
  The grant type's name.
• user(optional): object User

{
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The grant type's name."
        },
        "user":{
            "$ref":"#/definitions/User"
        },
        "group":{
            "$ref":"#/definitions/Group"
        },
        "createdBy":{
            "type":"string",
            "description":"The user who issued the grant."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the grant was issued."
        }
    }
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : Group

Type: object

Show Source

• id: string
  The group's ID.

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

Nested Schema : User

Type: object

Show Source

• id: string
  The user's ID.

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

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

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 retrieve a collection of grants issued for a specific API in Oracle API Platform Cloud Service 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/apis/{apiId}/grants

• {apiId} is the unique Id for an API. To retrieve available API Ids, see Get APIs.

You can pass the following optional field values in the fields query parameter, separated by commas, to include them in the response:

• createdAt: The date and time the grant was issued.

• createdBy: The user who issued the grant.

• user.roles: The roles the user is assigned.

• group.roles: The roles the group is assigned.

The following example shows you how to include these fields in the response:

curl -i -X GET 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/grants?fields=user.roles,group.roles

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 18:21:02 GMT
Content-length: 2031
Content-type: application/json
X-oracle-dms-ecid: DJczQ0npR00000000
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 grants issued for the API and HATEOAS links to related operations.

{
  "count": 1,
  "links": [
    {
      "templated": "true",
      "method": "GET",
      "rel": "grantees",
      "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ManageAPIGrant/grantees",
      "grant": "ManageAPIGrant"
    },
    {
      "templated": "true",
      "method": "GET",
      "rel": "grantees",
      "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ViewAllDetailsAPIGrant/grantees",
      "grant": "ViewAllDetailsAPIGrant"
    },
    {
      "templated": "true",
      "method": "GET",
      "rel": "grantees",
      "href": "https://example.com:443/apiplatform/management/v1/apis/grants/DeployAPIGrant/grantees",
      "grant": "DeployAPIGrant"
    },
    {
      "templated": "true",
      "method": "GET",
      "rel": "grantees",
      "href": "https://example.com:443/apiplatform/management/v1/apis/grants/ViewPublicDetailsAPIGrant/grantees",
      "grant": "ViewPublicDetailsAPIGrant"
    },
    {
      "templated": "true",
      "method": "GET",
      "rel": "self",
      "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants"
    },
    {
      "templated": "true",
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants"
    },
    {
      "method": "GET",
      "rel": "types",
      "href": "https://example.com:443/apiplatform/management/v1/apis/grants/types"
    },
    {
      "templated": "true",
      "method": "POST",
      "rel": "create",
      "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants",
      "grant": "ManageAPIGrant"
    },
    {
      "templated": "true",
      "method": "POST",
      "rel": "create",
      "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants",
      "grant": "ViewAllDetailsAPIGrant"
    },
    {
      "templated": "true",
      "method": "POST",
      "rel": "create",
      "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants",
      "grant": "DeployAPIGrant"
    },
    {
      "templated": "true",
      "method": "POST",
      "rel": "create",
      "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants",
      "grant": "ViewPublicDetailsAPIGrant"
    }
  ],
  "items": [
    {
      "links": [
        {
          "templated": "true",
          "method": "DELETE",
          "rel": "delete",
          "href": "https://example.com:443/apiplatform/management/v1/apis/141/grants/ManageAPIGrant/users/apicsadmin"
        }
      ],
      "type": "ManageAPIGrant",
      "user": {
        "roles": [
          "Administrator"
        ],
        "id": "apicsadmin"
      }
    }
  ]
}

Back to Top