Get grants issued for a service
/apiplatform/management/v1/services/{serviceId}/grants
Returns a collection of grants that have been issued for the {serviceId}
service. 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 Service Manager role and must be issued the Manage Service grant for the specified service.
Request
- application/json
-
serviceId: string
A unique ID referencing a specific service.
-
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. - links(optional): array
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
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
object
-
links(optional):
array links
Includes 'canonical'.
403 Response
object
-
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
500 Response
object
-
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
Examples
The following example shows how to retrieve a a collection of grants that have been issued for the 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/services/{serviceId}/grants
where {serviceId}
is a unique Id of a specific service. See Get Services.
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: Fri, 15 Dec 2017 07:24:25 GMT Content-Length: 2842 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.
{ "offset": 0, "count": 1, "limit": 128, "hasMore": false, "links": [ { "templated": "true", "method": "GET", "rel": "grantees", "href": "http://example.com:443/apiplatform/management/v1/services/grants/ManageServiceGrant/grantees", "grant": "ManageServiceGrant" }, { "templated": "true", "method": "GET", "rel": "grantees", "href": "http://example.com:443/apiplatform/management/v1/services/grants/ViewAllDetailsServiceGrant/grantees", "grant": "ViewAllDetailsServiceGrant" }, { "templated": "true", "method": "GET", "rel": "grantees", "href": "http://example.com:443/apiplatform/management/v1/services/grants/ReferenceServiceGrant/grantees", "grant": "ReferenceServiceGrant" }, { "templated": "true", "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/services/103/grants?offset=0&=128" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/services/103/grants" }, { "method": "GET", "rel": "types", "href": "http://example.com:443/apiplatform/management/v1/services/grants/types" }, { "templated": "true", "method": "POST", "rel": "create", "href": "http://example.com:443/apiplatform/management/v1/services/103/grants", "grant": "ManageServiceGrant" }, { "templated": "true", "method": "POST", "rel": "create", "href": "http://example.com:443/apiplatform/management/v1/services/103/grants", "grant": "ViewAllDetailsServiceGrant" }, { "templated": "true", "method": "POST", "rel": "create", "href": "http://example.com:443/apiplatform/management/v1/services/103/grants", "grant": "ReferenceServiceGrant" } ], "items": [ { "links": [ { "templated": "true", "method": "DELETE", "rel": "delete", "href": "http://example.com:443/apiplatform/management/v1/services/103/grants/ManageServiceGrant/users/apicsadmin" } ], "type": "ManageServiceGrant", "user": { "id": "apicsadmin" } } ] }