Add Member to Group

POST 
/api/groups/:groupKey/members/:userId

Add a member to a group with given key.

You can find more information about groups here.

Note: Invalidates all AccessToken because they would contain the wrong group information.

Tokens

• A valid AccessToken with ADMIN permissions is required.

Request

Responses

200

Updated user information.

401

The following error codes correspond to this status:

• ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.
• ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.
• AUTHENTICATION_REQUIRED: User is not authenticated.

403

The following error codes correspond to this status:

• ROLE_REQUIRED: Principal does not have required role.

404

The following error codes correspond to this status:

• GROUP_NOT_FOUND: No group with specified key found.
• USER_NOT_FOUND: User not found.

500

The following error codes correspond to this status:

• ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.
• DATABASE_FAILURE: Exception representing a general failure related to database operations.
• POST_COMMIT_SIDE_EFFECT_FAILURE: Exception representing a failure to perform a side effect after a successful database operation.
• INVALID_PRINCIPAL_DOCUMENT: A requested principal document was stored in an invalid format.