1. REST API for the Management Service in Oracle API Platform Cloud Service
  2. Tasks
  3. Applications
  4. Grants

Get eligible grantees

get

/apiplatform/management/v1/applications/grants/{grantType}/grantees

Returns users and groups in the identity management system who are eligible to receive the {grantType} application grant. By default, the role and ID of each eligible account is returned. Additional fields can be returned by sending any of these field names, separated by commas, in the fields query parameter: user.roles and group.roles.

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

Request

Supported Media Types
Path Parameters
Query Parameters
  • 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.
  • Number of items to retrieve. 1 is the minumum; 128 is the maximum.
    Default Value: 128
  • Offset the list returned results by this amount. Default is zero.
    Default Value: 0
  • Collection Format: csv
    Pass sorting criteria, comma separated.
  • Pass filtering criteria, using the SCIM filter expression syntax
  • Include the total result count in the response.
    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

The collection of grantees
Body ()
Root Schema : GetGranteesResponse
Match All
Show Source
Nested Schema : CollectionResponseFeature
Type: object
Show Source
Nested Schema : CollectionResponsePagingFeature
Type: object
Show Source
Nested Schema : GetGranteesResponse-allOf[2]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Grantee
Type: object
Show Source
Nested Schema : Group
Type: object
Show Source
Nested Schema : User
Type: object
Show Source

403 Response

Forbidden.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

500 Response

Unexpected error.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source
Back to Top

Examples

The following example shows how to retrieve the users and groups that are eligible to receive the specified application grant 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/applications/grants/{grantType}/grantees

{grantType} is the type of the grant that can be issued for applications. To retrieve available grant types, Get application grants.

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

  • 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/applications/grants/{grantType}/grantees?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 19:20:50 GMT
Content-length: 553
Content-type: application/json
X-oracle-dms-ecid: Ej84G0ZHZ00000000
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 users and groups that are eligible to receive the specified application grant.

{
  "count": 10,
  "links": [
    {
      "templated": "true",
      "method": "GET",
      "rel": "self",
      "href": "https://example.com:443/apiplatform/management/v1/applications/grants/ManageApplicationGrant/grantees"
    }
  ],
  "items": [
    {
      "user": {
        "roles": [
          "ApplicationDeveloper",
          "APIManager"
        ],
        "id": "app-dev-user"
      }
    },
    {
      "user": {
        "roles": [
          "Administrator"
        ],
        "id": "api-admin-user2"
      }
    },
    {
      "user": {
        "roles": [
          "APIManager"
        ],
        "id": "api-manager-user2"
      }
    },
    {
      "user": {
        "roles": [
          "ApplicationDeveloper"
        ],
        "id": "app-dev-user2"
      }
    },
    {
      "user": {
        "roles": [
          "Administrator"
        ],
        "id": "apicsadmin"
      }
    },
    {
      "user": {
        "roles": [
          "Administrator"
        ],
        "id": "api-admin-user"
      }
    },
    {
      "user": {
        "roles": [
          "GatewayRuntime",
          "APIManager"
        ],
        "id": "api-manager-user"
      }
    },
    {
      "group": {
        "roles": [
          "APIManager"
        ],
        "id": "APIManagers"
      }
    },
    {
      "group": {
        "roles": [
          "Administrator"
        ],
        "id": "APICSAdministrators"
      }
    },
    {
      "group": {
        "roles": [
          "ApplicationDeveloper"
        ],
        "id": "APPDevelopers"
      }
    }
  ]
}
Back to Top