Skip to main content

Create user

POST 

/Users

Create user

Request

Body

required

    active boolean

    Default value: false

    user status

    addresses

    object[]

  • Array [

  • country string
    locality string
    postalCode string
    region string
    streetAddress string
    type stringrequired

    Possible values: [work]

  • ]

  • emails

    object[]

  • Array [

  • type stringrequired

    Possible values: [work]

    value stringrequired
  • ]

  • externalId stringrequired

    external unique resource id defined by provisioning client

    id string

    unique resource id defined by Elfsquad

    name

    object

    familyName stringrequired
    givenName stringrequired

    phoneNumbers

    object[]

  • Array [

  • type stringrequired

    Possible values: [work, mobile, other]

    value stringrequired
  • ]

  • photos

    object[]

  • Array [

  • type stringrequired

    Possible values: [photo]

    value stringrequired
  • ]

  • schemas string[]

    Possible values: [urn:ietf:params:scim:schemas:core:2.0:User]

    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

    object

    department string
    userName stringrequired

    urn:ietf:params:scim:schemas:extension:elfsquad:2.0:User

    object

    currencyIso uuid
    languageIso uuid
    crmAccountId uuid
    crmContactId uuid
    isAdmin bool
    organizationId uuid

Responses

successfully created user

Schema

    active boolean

    Default value: false

    user status

    addresses

    object[]

  • Array [

  • country string
    locality string
    postalCode string
    region string
    streetAddress string
    type stringrequired

    Possible values: [work]

  • ]

  • emails

    object[]

  • Array [

  • type stringrequired

    Possible values: [work]

    value stringrequired
  • ]

  • externalId stringrequired

    external unique resource id defined by provisioning client

    id string

    unique resource id defined by Elfsquad

    name

    object

    familyName stringrequired
    givenName stringrequired

    phoneNumbers

    object[]

  • Array [

  • type stringrequired

    Possible values: [work, mobile, other]

    value stringrequired
  • ]

  • photos

    object[]

  • Array [

  • type stringrequired

    Possible values: [photo]

    value stringrequired
  • ]

  • schemas string[]

    Possible values: [urn:ietf:params:scim:schemas:core:2.0:User]

    urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

    object

    department string
    userName stringrequired

    urn:ietf:params:scim:schemas:extension:elfsquad:2.0:User

    object

    currencyIso uuid
    languageIso uuid
    crmAccountId uuid
    crmContactId uuid
    isAdmin bool
    organizationId uuid

    meta

    object

    resource metadata

    created date-time
    lastModified date-time
    location string

    resource location URI

    resourceType string

    Possible values: [User, Group]

Loading...