Skip to main content
PATCH
Update group
Requires the IAM action workspace:UpdateGroup. See WORKSPACE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

group_id
string<uuid>
required

Group ID

Body

application/json

The resource name is immutable.

description
string
Maximum string length: 1000
Example:

"Development team members"

Response

Group updated

group
object