Update Group Roles On Organization By Organization Id And Group Id Using PATCH

Update Group Roles On Organization By Organization Id And Group Id Using PATCH

Update roles of a group within organization.
Note: Email notification for updating group roles of group with more than 500 users will not be sent to its users.

Access Policy

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

Unique identifier of the group.

string
orgId
Required

Unique identifier (GUID) of the organization.


Request Body
UpdateGroupRolesRequest 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"
            }
        ]
    },
    "notifyUsersInGroups": 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"
        }
    ]
}
customRoles
Optional

Request body to update roles.

boolean
notifyUsersInGroups
Optional

Publish email notification to group members.

organizationRoles
Optional

Request body to update roles.

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

Group 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 with this identifier is 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