Update User Roles By User Id And Organization Id Using PATCH

Update User Roles By User Id And Organization Id Using PATCH

Update service and organization roles of a user in the organization

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
PATCH
https://{api_host}/csp/gateway/am/api/v3/users/{userId}/orgs/{orgId}/roles
COPY
Path Parameters
string
userId
Required

The userId or user account identifier.

string
orgId
Required

Unique identifier (GUID) of the organization.

Request Body
NotifiableUpdateMemberRolesRequest of type(s) application/json
Required 
{
    "customRoles": {
        "roleNamesToAdd": [
            "string"
        ],
        "roleNamesToRemove": [
            "string"
        ],
        "rolesToAdd": [
            {
                "createdBy": "string",
                "createdDate": "string",
                "expiresAt": 3609941597,
                "lastUpdatedBy": "string",
                "lastUpdatedDate": "string",
                "membershipType": "string",
                "name": "string",
                "resource": "string"
            }
        ],
        "rolesToRemove": [
            {
                "name": "string",
                "resource": "string"
            }
        ],
        "rolesToUpdate": [
            {
                "createdBy": "string",
                "createdDate": "string",
                "expiresAt": 3609941597,
                "lastUpdatedBy": "string",
                "lastUpdatedDate": "string",
                "membershipType": "string",
                "name": "string",
                "resource": "string"
            }
        ]
    },
    "notifyUsers": false,
    "organizationRoles": {
        "roleNamesToAdd": [
            "string"
        ],
        "roleNamesToRemove": [
            "string"
        ],
        "rolesToAdd": [
            {
                "createdBy": "string",
                "createdDate": "string",
                "expiresAt": 3609941597,
                "lastUpdatedBy": "string",
                "lastUpdatedDate": "string",
                "membershipType": "string",
                "name": "string",
                "resource": "string"
            }
        ],
        "rolesToRemove": [
            {
                "name": "string",
                "resource": "string"
            }
        ],
        "rolesToUpdate": [
            {
                "createdBy": "string",
                "createdDate": "string",
                "expiresAt": 3609941597,
                "lastUpdatedBy": "string",
                "lastUpdatedDate": "string",
                "membershipType": "string",
                "name": "string",
                "resource": "string"
            }
        ]
    },
    "serviceRoles": [
        {
            "roleNamesToAdd": [
                "string"
            ],
            "roleNamesToRemove": [
                "string"
            ],
            "rolesToAdd": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ],
            "rolesToRemove": [
                {
                    "name": "string",
                    "resource": "string"
                }
            ],
            "rolesToUpdate": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ],
            "serviceDefinitionId": "string"
        }
    ]
}
UpdateRolesRequestCustomRoleBindingDtoBaseRoleDto
customRoles
Optional

Request body to update roles.

boolean
notifyUsers
Optional

Send e-mail notification to the user(s).

UpdateRolesRequestBaseRoleBindingDtoBaseRoleDto
organizationRoles
Optional

Request body to update roles.

array of UpdateServiceRolesRequest
serviceRoles
Optional

Service roles to be updated.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

400

User not part of the organization

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization not found | User not found

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


On This Page
User Operations
GET
Get User Custom Roles By User Id And Organization Id Using GET
GET
Get User Groups By User Email And Organization Id Using GET
GET
Get User Groups By User Id And Organization Id Using GET
GET
Get User Info By User Id And Organization Id Using GET
GET
Get User Organization Roles By User Id And Organization Id Using GET
GET
Get User Service Roles By User Id And Organization Id Using GET
POST
Search Users In Idp By Names And Email Using POST
PATCH
Update User Roles By User Id And Organization Id Using PATCH