listInternalProfileRoles
get
/ccadmin/v1/adminRoles
List Internal Profile Roles. Get all roles for internal users.
Request
Supported Media Types
- application/json
Query Parameters
-
expand(optional): string
Expand query param: currently used to expand accessRights, category info and include security criteria information. Possible value for this query parameter is 'details'Allowed Values:
[ "details" ] -
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
offset(optional): string
This field determines the offset/starting index from which data will be fetched.
-
q(optional): string
SCIM query to search on the internal profile roles properties.
-
queryParser(optional): string
This parameter is required to use SCIM search on the internal profile roles properties. Possible value for this query parameter is 'SCIM'
-
sort(optional): string
This is the field to provide sort on the internal profile roles properties
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listInternalProfileRoles_response
Type:
Show Source
object-
items(optional):
array items
All roles 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-
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 the 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.
-
repositoryId(optional):
string
Repository ID of the role category.
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
ID of the security criterion.
-
name(optional):
string
Name of the security criterion.
-
repositoryId(optional):
string
Repository ID of the security criterion.
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)
[
{
"repositoryId":"customRole1",
"name":"Custom Role 1",
"description":"Custom Role 1",
"id":"customRole1",
"accessRights":[
{
"displayName":"GDPR 1",
"repositoryId":"gdpr1",
"name":"GDPR 1",
"description":"Access Right 1 for GDPR",
"id":"gdpr1",
"type":"privilege"
}
],
"securityCriteriaLastModified":"2020-08-17T04:55:39.652Z",
"category":"Custom"
}
]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|
|------------------|------------------|
|22050|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:
arrayAn 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