Deel: Users schemas
34 Deel schemas with complete fields and constraints.
← Users operations · All schemas
List users — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
Resources | array | Optional | |
Resources[] | Model | Each item | Expand List users — 200 response body — Resources item |
itemsPerPage | JSON | Optional | |
itemsPerPage (anyOf 1) | integer | Alternative | Format: int64 |
itemsPerPage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
schemas | array | Optional | |
schemas[] | string | Each item | Known values: urn:ietf:params:scim:api:messages:2.0:ListResponse |
startIndex | JSON | Optional | |
startIndex (anyOf 1) | integer | Alternative | Format: int64 |
startIndex (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalResults | JSON | Optional | |
totalResults (anyOf 1) | integer | Alternative | Format: int64 |
totalResults (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List users — 200 response body — Resources item
List users — 200 response body — Resources item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | boolean | Optional | Default: false |
addresses | array | Optional | |
addresses[] | Model | Each item | Expand List users — 200 response body — Resources item addresses item |
emails | array | Required within parent | |
emails[] | Model | Each item | Expand Retrieve a single User — 200 response body — emails item |
id | string | Optional | |
meta | Model | Required within parent | Expand List users — 200 response body — Resources item meta |
name | Model | Required within parent | Expand List users — 200 response body — Resources item name |
schemas | array | Required within parent | |
schemas[] | string | Each item | Known values: urn:ietf:params:scim:schemas:core:2.0:User |
title | string | Optional | |
urn:ietf:params:scim:schemas:extension:2.0:User | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User |
userName | string | Required within parent | |
userType | string | Optional |
Referenced models: List users — 200 response body — Resources item addresses item, Retrieve a single User — 200 response body — emails item, List users — 200 response body — Resources item meta, List users — 200 response body — Resources item name, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
List users — 200 response body — Resources item addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
country (anyOf 2) | null | Alternative | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
lineTwo | string | Optional | |
locality | string | Optional | |
postalCode | string | Optional | |
region | string | Optional | |
streetAddress | string | Optional | |
type | string | Optional |
List users — 200 response body — Resources item meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | string | Optional | |
lastModified | string | Optional | |
location | string | Optional | |
resourceType | string | Optional | Known values: User, Group |
List users — 200 response body — Resources item name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
familyName | JSON | Required within parent | |
familyName (anyOf 1) | string | Alternative | |
familyName (anyOf 2) | null | Alternative | |
givenName | JSON | Required within parent | |
givenName (anyOf 1) | string | Alternative | |
givenName (anyOf 2) | null | Alternative |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
birthday | string | Optional | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item |
customFields (anyOf 2) | null | Alternative | |
customFields (anyOf 2)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item |
departmentCustomFields | JSON | Optional | |
departmentCustomFields (anyOf 1) | object | Alternative | Org-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization. Additional keys: see wildcard field |
departmentCustomFields (anyOf 1).* | string | Additional keys | |
departmentCustomFields (anyOf 2) | null | Alternative | Org-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization. Additional keys: see wildcard field |
departmentCustomFields (anyOf 2).* | string | Additional keys | |
departmentExternalId | JSON | Optional | |
departmentExternalId (anyOf 1) | string | Alternative | |
departmentExternalId (anyOf 2) | null | Alternative | |
departmentExternalIdHierarchy | JSON | Optional | |
departmentExternalIdHierarchy (anyOf 1) | string | Alternative | |
departmentExternalIdHierarchy (anyOf 2) | null | Alternative | |
departmentHierarchy | JSON | Optional | |
departmentHierarchy (anyOf 1) | string | Alternative | |
departmentHierarchy (anyOf 2) | null | Alternative | |
employments | JSON | Optional | |
employments (anyOf 1) | array | Alternative | |
employments (anyOf 1)[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item |
employments (anyOf 2) | null | Alternative | |
employments (anyOf 2)[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item |
endDate | string | Optional | |
hiringStatus | string | Optional | |
isManager | boolean | Optional | Default: false |
jobProfile | JSON | Optional | Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission. |
jobProfile (anyOf 1) | Model | Alternative | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track |
jobProfile (anyOf 2) | null | Alternative | |
organizationalStructures | array | Optional | |
organizationalStructures[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional | |
preferredName | string | Optional | |
startDate | JSON | Optional | |
startDate (anyOf 1) | string | Alternative | |
startDate (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | string | Alternative | The work location label assigned to the worker's HRIS profile |
workLocation (anyOf 2) | null | Alternative | The work location label assigned to the worker's HRIS profile |
workerId | JSON | Optional | |
workerId (anyOf 1) | string | Alternative | |
workerId (anyOf 2) | null | Alternative | |
workerTerminationLastDateOfWork | JSON | Optional | |
workerTerminationLastDateOfWork (anyOf 1) | string | Alternative | |
workerTerminationLastDateOfWork (anyOf 2) | null | Alternative |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | boolean | Optional | Default: false |
contractId | string | Optional | |
contractType | JSON | Optional | |
contractType (anyOf 1) | string | Alternative | |
contractType (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
customFields | array | Optional | Contract-level custom fields associated with the employment |
customFields[] | Model | Each item | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item |
employeeNumber | JSON | Optional | |
employeeNumber (anyOf 1) | string | Alternative | |
employeeNumber (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | string | Alternative | |
startDate (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative | |
team | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | |
title (anyOf 2) | null | Alternative |
Referenced models: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item, List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Optional | The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, List has {option}, Multiselect has {options}. |
data (anyOf 1) | Model | Alternative | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item data object |
data (anyOf 2) | null | Alternative | |
id | string | Optional | |
name | string | Optional | |
type | string | Optional |
Referenced models: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item data object
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item data object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, List has {option}, Multiselect has {options}. |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
externalId | JSON | Optional | |
externalId (anyOf 1) | string | Alternative | |
externalId (anyOf 2) | null | Alternative | |
externalIdHierarchy | JSON | Optional | |
externalIdHierarchy (anyOf 1) | string | Alternative | |
externalIdHierarchy (anyOf 2) | null | Alternative | |
name | string | Optional | |
nameHierarchy | string | Optional | |
structureId | string | Optional | |
structureName | string | Optional |
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
costCenter | string | Optional | |
customFields | object | Optional | Additional keys: see wildcard field |
customFields.* | string | Additional keys | |
department | string | Optional | |
manager | Model | Optional | Expand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager |
organization | string | Optional | |
preferredFirstName | string | Optional | |
preferredLastName | string | Optional |
Referenced models: List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
displayName | string | Optional | |
email | string | Optional | |
value | string | Required within parent |
List users — request body — query filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | array | Alternative | |
$ (oneOf 2)[] | string | Each item |
Retrieve a single User — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | boolean | Optional | Default: false |
addresses | array | Optional | |
addresses[] | Model | Each item | Expand Retrieve a single User — 200 response body — addresses item |
emails | array | Required within parent | |
emails[] | Model | Each item | Expand Retrieve a single User — 200 response body — emails item |
id | string | Optional | |
meta | Model | Required within parent | Expand Retrieve a single User — 200 response body — meta |
name | Model | Required within parent | Expand Retrieve a single User — 200 response body — name |
phoneNumbers | array | Required within parent | |
phoneNumbers[] | Model | Each item | Expand Retrieve a single User — 200 response body — phone Numbers item |
schemas | array | Required within parent | |
schemas[] | string | Each item | Known values: urn:ietf:params:scim:schemas:core:2.0:User |
title | string | Optional | |
urn:ietf:params:scim:schemas:extension:2.0:User | Model | Optional | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | Model | Optional | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User |
userName | string | Required within parent | |
userType | string | Optional |
Referenced models: Retrieve a single User — 200 response body — emails item, Retrieve a single User — 200 response body — addresses item, Retrieve a single User — 200 response body — meta, Retrieve a single User — 200 response body — name, Retrieve a single User — 200 response body — phone Numbers item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
Retrieve a single User — 200 response body — addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
country (anyOf 2) | null | Alternative | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
locality | string | Optional | |
postalCode | string | Optional | |
region | string | Optional | |
streetAddress | string | Optional | |
type | string | Optional |
Retrieve a single User — 200 response body — emails item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
primary | boolean | Optional | Default: false |
type | string | Required within parent | Known values: home, work, other |
value | string | Required within parent |
Retrieve a single User — 200 response body — meta
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | string | Optional | Format: date-time |
lastModified | string | Optional | Format: date-time |
location | string | Optional | |
resourceType | string | Optional | Known values: User, Group |
Retrieve a single User — 200 response body — name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
familyName | string | Required within parent | |
givenName | string | Required within parent |
Retrieve a single User — 200 response body — phone Numbers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
primary | boolean | Required within parent | Default: false |
type | string | Required within parent | Known values: home, work, other |
value | string | Required within parent |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item |
customFields (anyOf 2) | null | Alternative | |
customFields (anyOf 2)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item |
customFieldsFlattened | JSON | Optional | |
customFieldsFlattened (anyOf 1) | object | Alternative | Custom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled. Additional keys: see wildcard field |
customFieldsFlattened (anyOf 1).* | Model | Additional keys | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value |
customFieldsFlattened (anyOf 2) | null | Alternative | Custom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled. Additional keys: see wildcard field |
customFieldsFlattened (anyOf 2).* | Model | Additional keys | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value |
departmentCustomFields | JSON | Optional | |
departmentCustomFields (anyOf 1) | object | Alternative | Org-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization. Additional keys: see wildcard field |
departmentCustomFields (anyOf 1).* | string | Additional keys | |
departmentCustomFields (anyOf 2) | null | Alternative | Org-structure custom fields resolved for the department node, keyed by normalized field name. Only present when the department custom fields feature flag is enabled for the organization. Additional keys: see wildcard field |
departmentCustomFields (anyOf 2).* | string | Additional keys | |
departmentExternalId | JSON | Optional | |
departmentExternalId (anyOf 1) | string | Alternative | |
departmentExternalId (anyOf 2) | null | Alternative | |
departmentExternalIdHierarchy | JSON | Optional | |
departmentExternalIdHierarchy (anyOf 1) | string | Alternative | |
departmentExternalIdHierarchy (anyOf 2) | null | Alternative | |
departmentHierarchy | JSON | Optional | |
departmentHierarchy (anyOf 1) | string | Alternative | |
departmentHierarchy (anyOf 2) | null | Alternative | |
employments | JSON | Optional | |
employments (anyOf 1) | array | Alternative | |
employments (anyOf 1)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item |
employments (anyOf 2) | null | Alternative | |
employments (anyOf 2)[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item |
endDate | Model | Optional | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date |
hiringStatus | string | Optional | |
isManager | boolean | Optional | Default: false |
jobProfile | JSON | Optional | Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission. |
jobProfile (anyOf 1) | Model | Alternative | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track |
jobProfile (anyOf 2) | null | Alternative | |
organizationalStructuresFlattened | JSON | Optional | |
organizationalStructuresFlattened (anyOf 1) | object | Alternative | Org structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled. Additional keys: see wildcard field |
organizationalStructuresFlattened (anyOf 1).* | Model | Additional keys | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value |
organizationalStructuresFlattened (anyOf 2) | null | Alternative | Org structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled. Additional keys: see wildcard field |
organizationalStructuresFlattened (anyOf 2).* | Model | Additional keys | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value |
startDate | JSON | Optional | |
startDate (anyOf 1) | string | Alternative | Format: date |
startDate (anyOf 2) | null | Alternative | Format: date |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative | |
workLocation | JSON | Optional | |
workLocation (anyOf 1) | string | Alternative | The work location label assigned to the worker's HRIS profile |
workLocation (anyOf 2) | null | Alternative | The work location label assigned to the worker's HRIS profile |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | |
value (anyOf 2) | null | Alternative |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | |
value (anyOf 2) | null | Alternative |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | boolean | Optional | Default: false |
contractId | string | Optional | |
contractType | JSON | Optional | |
contractType (anyOf 1) | string | Alternative | |
contractType (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
customFields | array | Optional | Contract-level custom fields associated with the employment |
customFields[] | Model | Each item | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item |
startDate | JSON | Optional | |
startDate (anyOf 1) | string | Alternative | |
startDate (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative | |
team | Model | Optional | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item team |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | |
title (anyOf 2) | null | Alternative |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | JSON | Optional | The custom field value payload, structure varies by field type |
data (anyOf 1) | Model | Alternative | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item data object |
data (anyOf 2) | null | Alternative | |
id | string | Optional | |
name | string | Optional | |
type | string | Optional |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item data object
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item data object
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The custom field value payload, structure varies by field type |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Format: date-time |
$ (anyOf 2) | string | Alternative | Known values: "" (empty string) |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Active job profile of the worker from job architecture. Present only when job profiles are enabled for the organization and job architecture is set up; null when the worker has no active job profile or the token lacks the job_profile.view permission. |
id | string | Optional | Job profile id. |
jobFamily | JSON | Optional | Job family of the job profile. |
jobFamily (anyOf 1) | Model | Alternative | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Job family of the job profile |
jobFamily (anyOf 2) | null | Alternative | |
jobFamilyGroup | JSON | Optional | Job family group of the job family. |
jobFamilyGroup (anyOf 1) | Model | Alternative | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Group Job family group of the job family |
jobFamilyGroup (anyOf 2) | null | Alternative | |
level | JSON | Optional | |
level (anyOf 1) | JSON | Alternative | |
level (anyOf 1) (anyOf 1) | integer | Alternative | Job profile level. |
level (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
level (anyOf 2) | null | Alternative | Job profile level. |
name | string | Optional | Job profile name. |
track | JSON | Optional | |
track (anyOf 1) | string | Alternative | Job profile track, as configured in job architecture (free text). |
track (anyOf 2) | null | Alternative | Job profile track, as configured in job architecture (free text). |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Job family of the job profile, Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Group Job family group of the job family
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Group Job family group of the job family
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job family group of the job family. |
id | string | Optional | Job family group id. |
name | string | Optional | Job family group name. |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User job Profile id, job Family, job Family Group, level, name, track job Family Job family of the job profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Job family of the job profile. |
id | string | Optional | Job family id. |
name | string | Optional | Job family name. |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
externalIdHierarchies | array | Optional | |
externalIdHierarchies[] | string | Each item | |
externalIds | array | Optional | |
externalIds[] | string | Each item | |
nameHierarchies | array | Optional | |
nameHierarchies[] | string | Each item | |
names | array | Optional | |
names[] | string | Each item | |
orgStructureName | string | Optional |
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
costCenter | string | Optional | |
department | string | Optional | |
manager | Model | Optional | Expand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager |
organization | string | Optional |
Referenced models: Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
displayName | string | Optional | |
value | string | Required within parent |