listAdminAccessRights
get
/ccadmin/v1/adminAccessRights
List Admin Access Rights. Get all access rights for internal users.
Request
Supported Media Types
- application/json
Query Parameters
-
includePrivileges(optional): boolean
Boolean indicating whether to include privileges in the response. Defaults to false.
-
limit(optional): string
The maximum number of access rights to be returned from this request.
-
offset(optional): string
The starting offset/index to be returned from this request.
-
q(optional): string
Query string that filters the access rights to be returned from this request using SCIM filtering syntax.
-
sort(optional): string
The sort order of the list to be returned from this request.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAdminAccessRights_response
Type:
Show Source
object
-
items(optional):
array items
All access rights for internal users
-
limit(optional):
string
Number of items to be fetched.
-
offset(optional):
string
The offset provided.
-
sort(optional):
array sort
An array that specifies the sort order.
-
total(optional):
string
Total number of items matching the searched string.
-
totalResults(optional):
string
Total number of items matching the searched string.
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 the access right
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Whether this property should be sorted ascending ("asc") or descending ("dsc").
-
property(optional):
string
The name of the property to use for sorting.
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":250,
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"displayName":"Sensitive Data",
"name":"Sensitive Data",
"repositoryId":"sensitiveData",
"description":"Access to sensitive data",
"id":"sensitiveData",
"type":"generic"
},
{
"displayName":"Very Sensitive Data",
"name":"Very Sensitive Data",
"repositoryId":"verySensitiveData",
"description":"Access to very sensitive data",
"id":"verySensitiveData",
"type":"generic"
}
]
}
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|
|------------------|------------------|
|22054|Invalid Query Expression|
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