Retrieve user by id

GET 
/Users/:id

Retrieve user by id

Request

Path Parameters

id stringrequired

user id

Responses

200

successful operation

application/json

Schema

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]

Example (from schema)

{
  "active": false,
  "addresses": [
    {
      "country": "string",
      "locality": "string",
      "postalCode": "string",
      "region": "string",
      "streetAddress": "string",
      "type": "work"
    }
  ],
  "emails": [
    {
      "type": "work",
      "value": "string"
    }
  ],
  "externalId": "string",
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "phoneNumbers": [
    {
      "type": "work",
      "value": "string"
    }
  ],
  "photos": [
    {
      "type": "photo",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "string"
  },
  "userName": "string",
  "urn:ietf:params:scim:schemas:extension:elfsquad:2.0:User": {
    "currencyIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "languageIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "crmContactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "meta": {
    "created": "2024-03-20T10:51:25.006Z",
    "lastModified": "2024-03-20T10:51:25.006Z",
    "location": "string",
    "resourceType": "User"
  }
}

application/scim+json

Schema

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]

Example (from schema)

{
  "active": false,
  "addresses": [
    {
      "country": "string",
      "locality": "string",
      "postalCode": "string",
      "region": "string",
      "streetAddress": "string",
      "type": "work"
    }
  ],
  "emails": [
    {
      "type": "work",
      "value": "string"
    }
  ],
  "externalId": "string",
  "id": "string",
  "name": {
    "familyName": "string",
    "givenName": "string"
  },
  "phoneNumbers": [
    {
      "type": "work",
      "value": "string"
    }
  ],
  "photos": [
    {
      "type": "photo",
      "value": "string"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "string"
  },
  "userName": "string",
  "urn:ietf:params:scim:schemas:extension:elfsquad:2.0:User": {
    "currencyIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "languageIso": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "crmContactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "meta": {
    "created": "2024-03-20T10:51:25.012Z",
    "lastModified": "2024-03-20T10:51:25.013Z",
    "location": "string",
    "resourceType": "User"
  }
}

401

authorization failure

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

403

permissions denied

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

404

not found

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

429

too many requests

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

500

internal server error

application/json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

application/scim+json

Schema

Schema

detail string

detail error message

schemas string[]

Possible values: [urn:ietf:params:scim:api:messages:2.0:Error]

scimType string

Possible values: [uniqueness, tooMany, mutability, sensitive, invalidSyntax, invalidFilter, invalidPath, invalidValue, invalidVers, noTarget]

bad request type when status code is 400

status string

same as HTTP status code, e.g. 400, 401, etc.

Example (from schema)

{
  "detail": "string",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "scimType": "uniqueness",
  "status": "string"
}

Loading...