[{"label":"Latest (v1.0)","version":"latest"}]
csp
Update Group Details In Organization By Organization ID And Group ID
DescriptionUpdate details of a custom group within organization.
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}
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
SIMPLE Explode:false
string
groupId
Required
Unique identifier of the group.
Parameter Serialization Style:
SIMPLE Explode:false
Request Body
Request Body
UpdateCustomGroupRequest
of mimetype application/json
Required
{
"name": "string"
}
string as ^[^@]+$
name
Required
Name of the custom group to be created.
string
description
Optional
Description of the custom group to be created.
Authentication
This operation uses the following authentication methods.
Errors
Errors
CspErrorResponse
400
Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
Updating shared group details is not allowed
CspErrorResponse
404
Organization with this identifier is not found. | Group with this identifier is not found.
CspErrorResponse
409
The Group with that name already exists
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 '{"description":"string","name":"string"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}
[{"label":"Latest (v1.0)","version":"latest"}]
csp
