Update Group Details In Organization By Organization Id And Group Id Using PATCH

Update Group Details In Organization By Organization Id And Group Id Using PATCH

Update details of a custom group within 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/orgs/{orgId}/groups/{groupId}
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

string
groupId
Required

Unique identifier of the group.

Request Body
UpdateCustomGroupRequest of type(s) application/json
Required 
"UpdateCustomGroupRequest Object"
string As ^[^@]+$
name
Required
Constraints: minLength: 0 maxLength: 200

Name of the custom group to be created.

string
description
Optional
Constraints: minLength: 0 maxLength: 500

Description of the custom group to be created.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

400

Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code

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

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

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 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

Updating shared group details is not allowed

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found. | Group with this identifier is not found.

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


409

The Group with that name already exists

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

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 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'
On This Page
Organization Groups Operations
POST
Add Users To Custom Group In Organization By Organization Id And Group Id Using POST
DELETE
Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE
GET
Get Users In Group Within Organization By Organization Id And Group Id Using GET
PATCH
Update Group Details In Organization By Organization Id And Group Id Using PATCH
GET
Get Group In Organization By Organization Id And Group Id Using GET
PATCH
Update Group Roles On Organization By Organization Id And Group Id Using PATCH
GET
Get Group Roles On Organization By Organization Id And Group Id Using GET
GET
Get Nested Enterprise Groups From Custom Group By Organization Id And Group Id Using GET
POST
Create Custom Group In Organization By Organization Id Using POST
DELETE
Remove Groups From Organization By Organization Id And Groups Id Using DELETE
GET
Get Organization Groups By Organization Id Using GET
POST
Search Groups Within Organization By Organization Id And Group Roles Using POST