[{"label":"Latest (v1.0)","version":"latest"}]
csp

Udpate Group Roles On Organization By Organization ID And Group ID

Description

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

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️

Request

Request

URL

URL


patch
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/roles
Copy

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.


serviceRoles Optional

Service roles to be updated.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

Errors

Errors

400

Group not part of the organization


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

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
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?