[{"label":"Latest (v1.0)","version":"latest"}]
csp
Update Group Roles On Organization By Organization ID And Group ID
DescriptionUpdate 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
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/roles
Path Parameters
Path Parameters
string
groupId
Required
Unique identifier of the group.
Parameter Serialization Style:
SIMPLE Explode:false
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
SIMPLE Explode:false
Request Body
Request Body
UpdateGroupRolesRequest
of mimetype application/json
Required
{
"customRoles": {
"roleNamesToAdd": [
"string"
],
"roleNamesToRemove": [
"string"
],
"rolesToAdd": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"rolesToRemove": [
{
"name": "string",
"resource": "string"
}
],
"rolesToUpdate": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
},
"notifyUsersInGroups": false,
"organizationRoles": {
"roleNamesToAdd": [
"string"
],
"roleNamesToRemove": [
"string"
],
"rolesToAdd": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"rolesToRemove": [
{
"name": "string",
"resource": "string"
}
],
"rolesToUpdate": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
},
"serviceRoles": [
{
"roleNamesToAdd": [
"string"
],
"roleNamesToRemove": [
"string"
],
"rolesToAdd": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"rolesToRemove": [
{
"name": "string",
"resource": "string"
}
],
"rolesToUpdate": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
CspErrorResponse
400
Group not part of the organization
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
The user is forbidden to use the API
CspErrorResponse
404
Organization with this identifier is not found.
CspErrorResponse
409
The request could not be processed due to a conflict
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{"customRoles":{"roleNamesToAdd":["string"],"roleNamesToRemove":["string"],"rolesToAdd":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}],"rolesToRemove":[{"name":"string","resource":"string"}],"rolesToUpdate":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}]},"notifyUsersInGroups":false,"organizationRoles":{"roleNamesToAdd":["string"],"roleNamesToRemove":["string"],"rolesToAdd":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}],"rolesToRemove":[{"name":"string","resource":"string"}],"rolesToUpdate":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}]},"serviceRoles":[{"roleNamesToAdd":["string"],"roleNamesToRemove":["string"],"rolesToAdd":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}],"rolesToRemove":[{"name":"string","resource":"string"}],"rolesToUpdate":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}],"serviceDefinitionId":"string"}]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/roles
[{"label":"Latest (v1.0)","version":"latest"}]
csp
