REST API for Oracle Commerce Cloud December 2017

updateUserRoles

post

/ccadmin/v1/profiles/{id}/updateUserRoles

Update User Roles. This operation is used to update the roles for the profile. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Body Parameter

Root Schema : updateUserRoles_request

Example


{
    "roles":[
        {
            "op":"add",
            "function":"approver",
            "relativeTo":{
                "id":"200002"
            }
        },
        {
            "op":"remove",
            "function":"admin",
            "relativeTo":{
                "id":"200002"
            }
        }
    ]
}

Properties

roles: Type: array roles

Required: true

Additional Properties Allowed:

List of role's function that need to associate with the user.

Nested Schema : roles

Type: array

List of role's function that need to associate with the user.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

function: Type: string

Function of the role to be assigned.
op: Type: string

Operation on the role to be performed. Possible values are add and remove
relativeTo: Type: object relativeTo

Additional Properties Allowed:

If not provided organization id will be cosidered as its parent organization ID

Nested Schema : relativeTo

Type: object

If not provided organization id will be cosidered as its parent organization ID

Properties

id: Type: string

Organization ID of the role to be assigned

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateUserRoles_response

Properties

message: Type: string

Returns Roles has been updated successfully message if action is successfull.
success: Type: boolean

Returns true if the action performed successfully.

Example application/json


{
    "success":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/profiles/bb-110000/updateUserRoles"
        }
    ],
    "message":"Roles has been updated successfully."
}

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| |------------------|------------------| |22019|If some internal error occurs while updating roles to the user.| |1002017|If user tries to update roles for non b2b users.| |22020|If roles provided is empty or null.| |89008|If roles with op as remove from input is not available for the profile.| |22023|If invalid op is passed in roles input.| |89007|If other organization roles which are not associated to the profile is passed in input.| |22002|If profile id passed is invalid.| |89005|If user tries to remove the buyer roles.| |22007|If roles input provided is invalid.| |89001|If invalid organization role(s) are passed.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{"roles": [
  {
    "op": "add",
    "function": "approver",
    "relativeTo": {"id": "200002"}
  },
  {
    "op": "remove",
    "function": "admin",
    "relativeTo": {"id": "200002"}
  }
]}

Sample Response Payload returned by endpoint:

{
  "success": true,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/profiles/bb-110000/updateUserRoles"
  }],
  "message": "Roles has been updated successfully."
}