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

csp

Update 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 500 users will not be sent to its users.

Access Policy

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

Request

URL

patch

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

Copy

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

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"
		}
	]
}

UpdateRolesRequestCustomRoleBindingDtoBaseRoleDto

customRoles Optional

Request body to update roles.

boolean

notifyUsersInGroups Optional

Publish email notification to group members.

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.

Bearer

Response

200 OK

Operation doesn't return any data structure.

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-required-roles: org_owner,org_admin
x-slo-tier: TIER2

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

csp

Organization Groups Operations

post

Add Users To Custom Group In Organization By Organization ID And Group ID

post

Create Custom Group In Organization By Organization ID

get

Get Group In Organization By Organization ID And Group ID

get

Get Group Roles On Organization By Organization ID And Group ID

get

Get Nested Enterprise Groups From Custom Group By Organization ID And Group ID

get

Get Organization Groups By Organization ID

get

Get Users In Group Within Organization By Organization ID And Group ID

delete

Remove Groups From Organization By Organization ID And Groups ID

delete

Remove Users From Custom Group In Organization By Organization ID And Group ID And User Ids

post

Search Groups Within Organization By Organization ID And Group Roles

patch

Update Group Details In Organization By Organization ID And Group ID

patch

Update Group Roles On Organization By Organization ID And Group ID

Update Group Roles On Organization By Organization ID And Group ID

Access Policy

Request

URL

Path Parameters

Request Body

Authentication

Bearer

Response

200 OK

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Organization Groups Operations

Was this page helpful?