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

Update Group Details In Organization By Organization ID And Group ID

Description

Update details of a custom group within organization.

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}
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

Errors

Errors

400

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


401

The user is not authorized to use the API


403

Updating shared group details is not allowed


404

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


409

The Group with that name already exists


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 '{"description":"string","name":"string"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}
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?