Skip to main content

Set the groups for a person

Add the person to the groups specified in the request body, and remove the person from any other existing groups. All groups in the request body must already exist. Duplicate groups in the request body will be ignored. If an empty list is supplied in the request body, the person will be removed from all groups they are currently a member of, and will not be added to any others. New groups can be created with the POST /groups endpoint.

Path Parameters
  • person_id string required

    The person ID

    Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required
  • groups string[]

    Possible values: Value must match regular expression ^[A-Za-z0-9]{1}[\w\.\-]{0,98}[A-Za-z0-9]$

Responses

OK


Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result string[]

    Possible values: Value must match regular expression ^[A-Za-z0-9]{1}[\w\.\-]{0,98}[A-Za-z0-9]$