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

updateAdminRole

put

/ccadmin/v1/adminRoles/{id}

Update Admin Profile Role. Updates a given role by ID.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : updateAdminRole_request
Type: object
Show Source
Example:
{
    "securityCriteria":[
        {
            "id":"sc-1100"
        }
    ],
    "name":"Administrator",
    "description":"adminRole",
    "accessRights":[
        {
            "repositoryId":"ora.adminPrivilege"
        }
    ]
}
Nested Schema : accessRights
Type: array
Access rights and privileges to assign to the role
Show Source
Nested Schema : securityCriteria
Type: array
Security criteria to assign to the role
Show Source
Nested Schema : items
Type: object
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 : createAdminRole_response
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights assigned to the role
Show Source
Nested Schema : securityCriteria
Type: array
Security criteria assigned to the role
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "securityCriteria":[
        {
            "name":"Security Criterion for Catalog",
            "description":"Grant access to catalogs: ClassicalMoviesCatalog",
            "id":"sc-1100"
        }
    ],
    "name":"Administrator",
    "repositoryId":"adminRole",
    "description":"Administrator Role",
    "id":"adminRole",
    "accessRights":[
        {
            "displayName":"Administrator",
            "name":"Administrator",
            "repositoryId":"ora.adminPrivilege",
            "description":"Administrator Privilege",
            "id":"ora.adminPrivilege",
            "type":"privilege"
        }
    ],
    "securityCriteriaLastModified":"2020-08-17T04:55:39.652Z",
    "category":"Administrator"
}

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| |------------------|------------------| |22048|If there was no role found with the given id. Or if the input passed is invalid. Or if there was an internal error while updating the role. Or if the current user would have lost admin privilege. Or if a profile having this role would end up with no privilege.|
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