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

Get eligible grantees

get

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

Returns users and groups in the identity management system who are eligible to receive the {grantType} service grant. By default, the role and ID of each eligible 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 Service 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 users and groups in the identity management system who are eligible to receive the service grant by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/services/grants/{grantType}/grantees

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:  1506
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 example shows the contents of the response body in JSON format, including details about users and groups in the identity management system who are eligible to receive the service grant:

{
    "offset": 0,
    "count": 11,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/services/grants/ReferenceServiceGrant/grantees?offset=0&=128"
        }
    ],
    "items": [
        {
            "group": {
                "id": "APICSAdministrators"
            }
        },
        {
            "group": {
                "id": "APIManagers"
            }
        },
        {
            "group": {
                "id": "ServiceManagers"
            }
        },
        {
            "group": {
                "id": "APIServiceManagers"
            }
        },
        {
            "user": {
                "id": "api-admin-user2"
            }
        },
        {
            "user": {
                "id": "api-manager-user2"
            }
        },
        {
            "user": {
                "id": "api-service-user2"
            }
        },
        {
            "user": {
                "id": "apicsadmin"
            }
        },
        {
            "user": {
                "id": "api-admin-user"
            }
        },
        {
            "user": {
                "id": "api-manager-user"
            }
        },
        {
            "user": {
                "id": "api-service-user"
            }
        }
    ]
}
Back to Top