1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Roles

createRole

post

/ccadmin/v1/roles

Creates a new role. Roles can be of 2 types - 'role' and 'organizationalRole'. All organizationalRoles are created relative to an organization and have the function as 'custom'. If no type is specified, role of type 'role' is created.

Request

Supported Media Types
Query Parameters
Body ()
Root Schema : createRole_request
Type: object
Show Source
Example:
{
    "name":"Custom Role",
    "repositoryId":"customRole",
    "description":"Custom Role",
    "accessRights":[
        {
            "repositoryId":"customAccessRight1"
        }
    ]
}
Nested Schema : accessRights
Type: array
Access rights to assign to role
Show Source
Nested Schema : relativeTo
Type: object
Organization for which the organizational role must be created. Required for type organizationalRole. Not allowed with type role.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getRole_response
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights assigned to role
Show Source
Nested Schema : relativeTo
Type: object
Related organization for organizationRole
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "name":"Custom Role",
    "repositoryId":"customRole",
    "description":"Custom Role",
    "id":"customRole",
    "accessRights":[
        {
            "displayName":"Custom Access Right 1",
            "name":"Custom Access Right 1",
            "repositoryId":"customAccessRight1",
            "description":"Custom Access Right 1",
            "id":"customAccessRight1",
            "type":"generic"
        }
    ],
    "type":"role"
}

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| |------------------|------------------| |22047|If input passed is invalid| |22055|If type, relativeTo or function passed are invalid| |22102|If a restricted privilege is being added to an organizationalRole|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top