Skip to main content

Create or update a person (idempotent)​

This endpoint works as the POST /persons endpoint, except that it is idempotent. If the person already exists, it will be updated with the new data and 200 status code will be returned.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Request Body required

The person creation request

  • active boolean

    A flag indicating whether the person should be active or not

  • roles string[]

    A list of roles to assign the person to. Previous roles are overwritten. Roles must already exist. Roles have format {organization_id}/{role_name}. Roles can be created with this API endpoint.

  • attributes object

    Attributes divided into named buckets. Bucket names are top level keys; attributes are values. Attributes consist of key-value pairs. Attribute names (keys) may be at most 70 bytes long. Attribute values must be JSON-serializable and are limited to 64KiB.

  • property name*
  • handles object[]

    the list of handles for the user

  • type string required

    Possible values: [email_address, phone_number, username]

  • value string required
  • groups string[]

    Possible values: <= 100 characters, Value must match regular expression ^[A-Za-z0-9]{1}[\w\.\-]*[A-Za-z0-9]$

    A list of group names to assign the person to. Previous groups are overwritten. Groups must already exist.

  • region string

    Possible values: [us-iowa, europe-belgium, asia-japan, europe-england, australia-sydney]

  • credentials object[]
Responses

OK - person already exists and was updated

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

    Abridged person structure

  • active boolean

    A flag indicating whether the person is active or not

  • person_id string

    The ID of the person

  • person_type string

    Possible values: [regular, anonymous]

  • roles string[]

    A list of roles to assign the person to. Roles must already exist. Roles have format {organization_id}/{role_name}. Roles can be created with this API endpoint.

  • region string

    Possible values: [us-iowa, europe-belgium, asia-japan, europe-england, australia-sydney]

  • handles object[]
  • type string

    Possible values: [email_address, phone_number, username]

  • value string
  • groups string[]

    Possible values: <= 100 characters, Value must match regular expression ^[A-Za-z0-9]{1}[\w\.\-]*[A-Za-z0-9]$

  • attributes object

    Attributes divided into named buckets. Bucket names are top level keys; attributes are values. Attributes consist of key-value pairs. Attribute names (keys) may be at most 70 bytes long. Attribute values must be JSON-serializable and are limited to 64KiB.

  • property name*