Jump to

• Request
• Response

addUserRoles

post

/ccadmin/v1/profiles/{id}/addRoles

add User Roles. This operation is used to add the roles for the profile w.r.t the associations specified.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request

Body ()

Root Schema : addRoles_request

Type: object

Show Source

• roles(required): array roles
  List of roles to associate with the user.

{
    "properties":{
        "roles":{
            "description":"List of roles to associate with the user.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "associations":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "relatedItemId":{
                                    "description":"It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null",
                                    "type":"string"
                                },
                                "type":{
                                    "description":"If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"Repository ID of the role to be assigned.",
                        "type":"string"
                    }
                }
            }
        }
    },
    "required":[
        "roles"
    ],
    "example":{
        "roles":[
            {
                "associations":[
                    {
                        "relatedItemId":"or-100001",
                        "type":"organization"
                    }
                ],
                "id":"role-100001"
            },
            {
                "associations":[
                    {
                        "relatedItemId":null,
                        "type":"global"
                    }
                ],
                "id":"role-100002"
            }
        ]
    }
}

Example:

{
    "roles":[
        {
            "associations":[
                {
                    "relatedItemId":"or-100001",
                    "type":"organization"
                }
            ],
            "id":"role-100001"
        },
        {
            "associations":[
                {
                    "relatedItemId":null,
                    "type":"global"
                }
            ],
            "id":"role-100002"
        }
    ]
}

Nested Schema : roles

Type: array

List of roles to associate with the user.

Show Source

• Array of: object items

{
    "description":"List of roles to associate with the user.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "associations":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "relatedItemId":{
                            "description":"It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null",
                            "type":"string"
                        },
                        "type":{
                            "description":"If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).",
                            "type":"string"
                        }
                    }
                }
            },
            "id":{
                "description":"Repository ID of the role to be assigned.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• associations: array associations
• id: string
  Repository ID of the role to be assigned.

{
    "type":"object",
    "properties":{
        "associations":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "relatedItemId":{
                        "description":"It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null",
                        "type":"string"
                    },
                    "type":{
                        "description":"If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"Repository ID of the role to be assigned.",
            "type":"string"
        }
    }
}

Nested Schema : associations

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "relatedItemId":{
                "description":"It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null",
                "type":"string"
            },
            "type":{
                "description":"If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• relatedItemId: string
  It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null
• type: string
  If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).

{
    "type":"object",
    "properties":{
        "relatedItemId":{
            "description":"It is the organization id to which role is associated. If the role is to be assigned in organization scope the relatedItemId is required and if the role is global scope then it should be null",
            "type":"string"
        },
        "type":{
            "description":"If the role is to be assigned in organization scope the type is (organization) and if the role is global scope the type is (global).",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : addRoles_response

Type: object

Show Source

• success: boolean
  Returns true if the action performed successfully.

{
    "properties":{
        "success":{
            "description":"Returns true if the action performed successfully.",
            "type":"boolean"
        }
    }
}

Example Response (application/json)

{
    "success":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/profiles/bb-110000/addRoles"
        }
    ]
}

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 adding roles to the user.| |22020|If roles provided is empty or null. |13037|If the required property is missing in the request. |22055|If roles provided is not in correct format.| |89014|If roles provided contains an accessRight with privilege.| |22002|If profile id passed is invalid.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top