getAdminRole
get
/ccadmin/v1/adminRoles/{id}
Get Admin Profile Role. Returns a role by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Admin Role ID.
Query Parameters
-
expand(optional): string
Expand query param: currently used to expand category information. Possible value for this query parameter is 'category'Allowed Values:
[ "category" ]
-
roleNotFoundError(optional): boolean
This param is used to throw an error when role is not found. Defaults to true. Deprecated.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAdminRole_response
Type:
Show Source
object
-
accessRights(optional):
array accessRights
Access rights assigned to the role
-
category(optional):
array category
Category of the role
-
description(optional):
string
Description of the role
-
id(optional):
string
ID of the role
-
name(optional):
string
Name of the role
-
repositoryId(optional):
string
Repository ID of the role
-
securityCriteria(optional):
array securityCriteria
Security criteria assigned to the role
-
securityCriteriaLastModified(optional):
string
Security criteria last modified timestamp.
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Description of the access right
-
displayName(optional):
string
Display name of the access right
-
id(optional):
string
ID of the access right
-
name(optional):
string
Name of the access right
-
repositoryId(optional):
string
Repository ID of the access right
-
type(optional):
string
Type of access right
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
Display name of the role category.
-
id(optional):
string
ID of the role category.
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Description of the security criterion
-
id(optional):
string
ID of the security criterion
-
name(optional):
string
Name of the security criterion
Example Response (application/json)
{
"securityCriteria":[
],
"name":"Administrator",
"repositoryId":"adminRole",
"description":"Administrator Role",
"id":"adminRole",
"accessRights":[
{
"displayName":"Administrator",
"name":"Administrator",
"repositoryId":"ora.adminPrivilege",
"description":"Administrator Privilege",
"id":"ora.adminPrivilege",
"type":"privilege"
}
],
"securityCriteriaLastModified":"2020-08-17T04:55:39.652Z",
"category":"Administrator"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|22049|If there was no role found with the given id|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code