Get role details
get
/apiplatform/administration/v1/roles/{roleId}
Returns the name and description of the {roleId}
role. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned the Administrator role.
Request
Supported Media Types
- application/json
Path Parameters
-
roleId: string
A unique ID referencing a specific role.
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. - links(optional): array
Response
Supported Media Types
- application/json
200 Response
The role details.
Nested Schema : RoleResource
Type:
Show Source
object
-
description(optional):
string
The role's description.
-
id(optional):
string
The role's ID.
-
name(optional):
string
The role's name.
Nested Schema : LinksResponseFeature
Type:
Show Source
object
-
links(optional):
array links
Includes 'canonical'.
Nested Schema : HATEOASLink
Type:
Show Source
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
400 Response
Bad request, indicates a problem with the input parameters.
Root Schema : Error
Type:
Show Source
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
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
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
Unexpected error.
Root Schema : Error
Type:
Show Source
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 information about a specific role 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 -u apicsadmin:password https://example.com/apiplatform/administration/v1/roles/APIManager
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 13:48:20 GMT Content-length: 716 Content-type: application/json X-oracle-dms-ecid: VwRu30mgR00000000 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 details about the role and HATEOAS links to related operations.
{ "name": "API Manager", "description": "People responsible for managing the API lifecycle, which includes designing, implementing, and versioning APIs. Also responsible for managing grants and applications, providing API documentation, and monitoring API performance.", "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager" }, { "templated": "true", "method": "GET", "rel": "preview", "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager/preview" }, { "templated": "true", "method": "POST", "rel": "grant", "href": "https://example.com:443/apiplatform/administration/v1/roles/APIManager/members" } ], "id": "APIManager" }