Skip to main content
POST
Add user to group
Requires the IAM action workspace:ManageGroupMembership. 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.

Headers

Idempotency-Key
string

Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.

Maximum string length: 255

Path Parameters

user_id
string<uuid>
required

User ID

Body

application/json
group
string
required

Group UUID, immutable name in the authenticated organization, or organization-qualified Workspace CRN. Groups contain users only.

Example:

"crn:workspace:::organization/550e8400-e29b-41d4-a716-446655440000/group/developers"

Response

Request successful, no content returned