1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Internal Profile Roles

listInternalProfileRoles

get

/ccadmin/v1/adminRoles

List Internal Profile Roles. Get all roles for the internal user.

Request

There are no request parameters for this operation.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listInternalProfileRoles_response
Nested Schema : items
Type: array
All roles for the internal user
Nested Schema : items
Type: object
Example application/json

{
    "items":[
        {
            "name":"Administrator",
            "repositoryId":"adminRole",
            "description":"Administrator Role",
            "category":"Administrator"
        },
        {
            "name":"Publishing",
            "repositoryId":"publishingRole",
            "description":"Publishing role",
            "category":"Commerce Cloud"
        }
    ]
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{"items": [
  {
    "name": "Administrator",
    "repositoryId": "adminRole",
    "description": "Administrator Role",
    "category": "Administrator"
  },
  {
    "name": "Publishing",
    "repositoryId": "publishingRole",
    "description": "Publishing role",
    "category": "Commerce Cloud"
  }
]}