OFoffice-of-national-statistics
Groups

Add user to group

Adds a user to an existing group in Cognito

post/groups/{id}/members

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header Authorization

Path parameters

idstring required

the group's ID

Request body

user_idstring required

Response

User added to group

idstring

The group ID

namestring

The group name

precedenceinteger

The priority of the group

createdstring date-time

The date the group was created

last_modified_datestring date-time
role_arnstring
user_pool_idstring

Example response

{
  "created": "YYYY-MM-DD hh:mm:ssZ",
  "last_modified_date": "YYYY-MM-DD hh:mm:ssZ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.