OFoffice-of-national-statistics
Groups

Remove user from group

Removes a user from an existing group in Cognito

delete/groups/{id}/members/{user_id}

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

user_idstring required

the id of the user being removed from the group

Response

User removed from 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.