getAdminAccessRight
get
/ccadmin/v1/adminAccessRights/{id}
Get Admin Access Right. Returns an access right by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The access right ID.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAdminAccessRight_response
Type:
Show Source
object
-
category:
object category
-
description:
string
Description of the access right
-
displayName:
string
Display name of the access right
-
id:
string
ID of the access right
-
name:
string
Name of the access right
-
repositoryId:
string
Repository ID of the access right
-
type:
string
Type of the access right
Nested Schema : category
Type:
Show Source
object
-
displayName:
string
Display name of the access right category
-
id:
string
ID of the access right category
Example Response (application/json)
{
"displayName":"Sensitive Data",
"name":"Sensitive Data",
"repositoryId":"sensitiveData",
"description":"Access to sensitive data",
"id":"sensitiveData",
"type":"generic",
"category":{
"displayName":"Custom",
"id":"customAccessRightCategory"
}
}
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|
|------------------|------------------|
|22053|If there was no access right found with the given id|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code