Skip to content

Deel: Users schemas

34 Deel schemas with complete fields and constraints.

← Users operations · All schemas

List users — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
ResourcesarrayOptional
Resources[]ModelEach itemExpand List users — 200 response body — Resources item
itemsPerPageJSONOptional
itemsPerPage (anyOf 1)integerAlternativeFormat: int64
itemsPerPage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
schemasarrayOptional
schemas[]stringEach itemKnown values: urn:ietf:params:scim:api:messages:2.0:ListResponse
startIndexJSONOptional
startIndex (anyOf 1)integerAlternativeFormat: int64
startIndex (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalResultsJSONOptional
totalResults (anyOf 1)integerAlternativeFormat: int64
totalResults (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List users — 200 response body — Resources item

List users — 200 response body — Resources item

FieldTypePresenceDescription and constraints
$objectRoot
activebooleanOptionalDefault: false
addressesarrayOptional
addresses[]ModelEach itemExpand List users — 200 response body — Resources item addresses item
emailsarrayRequired within parent
emails[]ModelEach itemExpand Retrieve a single User — 200 response body — emails item
idstringOptional
metaModelRequired within parentExpand List users — 200 response body — Resources item meta
nameModelRequired within parentExpand List users — 200 response body — Resources item name
schemasarrayRequired within parent
schemas[]stringEach itemKnown values: urn:ietf:params:scim:schemas:core:2.0:User
titlestringOptional
urn:ietf:params:scim:schemas:extension:2.0:UserModelOptionalExpand 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:UserModelOptionalExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
userNamestringRequired within parent
userTypestringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
country (anyOf 2)nullAlternativeMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
lineTwostringOptional
localitystringOptional
postalCodestringOptional
regionstringOptional
streetAddressstringOptional
typestringOptional

List users — 200 response body — Resources item meta

FieldTypePresenceDescription and constraints
$objectRoot
createdstringOptional
lastModifiedstringOptional
locationstringOptional
resourceTypestringOptionalKnown values: User, Group

List users — 200 response body — Resources item name

FieldTypePresenceDescription and constraints
$objectRoot
familyNameJSONRequired within parent
familyName (anyOf 1)stringAlternative
familyName (anyOf 2)nullAlternative
givenNameJSONRequired within parent
givenName (anyOf 1)stringAlternative
givenName (anyOf 2)nullAlternative

List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User

FieldTypePresenceDescription and constraints
$objectRoot
birthdaystringOptional
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
customFieldsJSONOptional
customFields (anyOf 1)arrayAlternative
customFields (anyOf 1)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
customFields (anyOf 2)nullAlternative
customFields (anyOf 2)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
departmentCustomFieldsJSONOptional
departmentCustomFields (anyOf 1)objectAlternativeOrg-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).*stringAdditional keys
departmentCustomFields (anyOf 2)nullAlternativeOrg-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).*stringAdditional keys
departmentExternalIdJSONOptional
departmentExternalId (anyOf 1)stringAlternative
departmentExternalId (anyOf 2)nullAlternative
departmentExternalIdHierarchyJSONOptional
departmentExternalIdHierarchy (anyOf 1)stringAlternative
departmentExternalIdHierarchy (anyOf 2)nullAlternative
departmentHierarchyJSONOptional
departmentHierarchy (anyOf 1)stringAlternative
departmentHierarchy (anyOf 2)nullAlternative
employmentsJSONOptional
employments (anyOf 1)arrayAlternative
employments (anyOf 1)[]ModelEach itemExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item
employments (anyOf 2)nullAlternative
employments (anyOf 2)[]ModelEach itemExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item
endDatestringOptional
hiringStatusstringOptional
isManagerbooleanOptionalDefault: false
jobProfileJSONOptionalActive 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)ModelAlternativeExpand 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)nullAlternative
organizationalStructuresarrayOptional
organizationalStructures[]ModelEach itemExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item
preferredFirstNamestringOptional
preferredLastNamestringOptional
preferredNamestringOptional
startDateJSONOptional
startDate (anyOf 1)stringAlternative
startDate (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative
workLocationJSONOptional
workLocation (anyOf 1)stringAlternativeThe work location label assigned to the worker's HRIS profile
workLocation (anyOf 2)nullAlternativeThe work location label assigned to the worker's HRIS profile
workerIdJSONOptional
workerId (anyOf 1)stringAlternative
workerId (anyOf 2)nullAlternative
workerTerminationLastDateOfWorkJSONOptional
workerTerminationLastDateOfWork (anyOf 1)stringAlternative
workerTerminationLastDateOfWork (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
activebooleanOptionalDefault: false
contractIdstringOptional
contractTypeJSONOptional
contractType (anyOf 1)stringAlternative
contractType (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
customFieldsarrayOptionalContract-level custom fields associated with the employment
customFields[]ModelEach itemExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item
employeeNumberJSONOptional
employeeNumber (anyOf 1)stringAlternative
employeeNumber (anyOf 2)nullAlternative
startDateJSONOptional
startDate (anyOf 1)stringAlternative
startDate (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative
teamModelOptionalExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
titleJSONOptional
title (anyOf 1)stringAlternative
title (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
dataJSONOptionalThe 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)ModelAlternativeExpand 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)nullAlternative
idstringOptional
namestringOptional
typestringOptional

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

FieldTypePresenceDescription and constraints
$objectRootThe 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

FieldTypePresenceDescription and constraints
$objectRoot
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative

List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures item

FieldTypePresenceDescription and constraints
$objectRoot
externalIdJSONOptional
externalId (anyOf 1)stringAlternative
externalId (anyOf 2)nullAlternative
externalIdHierarchyJSONOptional
externalIdHierarchy (anyOf 1)stringAlternative
externalIdHierarchy (anyOf 2)nullAlternative
namestringOptional
nameHierarchystringOptional
structureIdstringOptional
structureNamestringOptional

List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User

FieldTypePresenceDescription and constraints
$objectRoot
costCenterstringOptional
customFieldsobjectOptionalAdditional keys: see wildcard field
customFields.*stringAdditional keys
departmentstringOptional
managerModelOptionalExpand List users — 200 response body — Resources item urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
organizationstringOptional
preferredFirstNamestringOptional
preferredLastNamestringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
displayNamestringOptional
emailstringOptional
valuestringRequired within parent

List users — request body — query filter

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternative
$ (oneOf 2)arrayAlternative
$ (oneOf 2)[]stringEach item

Retrieve a single User — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
activebooleanOptionalDefault: false
addressesarrayOptional
addresses[]ModelEach itemExpand Retrieve a single User — 200 response body — addresses item
emailsarrayRequired within parent
emails[]ModelEach itemExpand Retrieve a single User — 200 response body — emails item
idstringOptional
metaModelRequired within parentExpand Retrieve a single User — 200 response body — meta
nameModelRequired within parentExpand Retrieve a single User — 200 response body — name
phoneNumbersarrayRequired within parent
phoneNumbers[]ModelEach itemExpand Retrieve a single User — 200 response body — phone Numbers item
schemasarrayRequired within parent
schemas[]stringEach itemKnown values: urn:ietf:params:scim:schemas:core:2.0:User
titlestringOptional
urn:ietf:params:scim:schemas:extension:2.0:UserModelOptionalExpand 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:UserModelOptionalExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User
userNamestringRequired within parent
userTypestringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternativeMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
country (anyOf 2)nullAlternativeMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
localitystringOptional
postalCodestringOptional
regionstringOptional
streetAddressstringOptional
typestringOptional

Retrieve a single User — 200 response body — emails item

FieldTypePresenceDescription and constraints
$objectRoot
primarybooleanOptionalDefault: false
typestringRequired within parentKnown values: home, work, other
valuestringRequired within parent

Retrieve a single User — 200 response body — meta

FieldTypePresenceDescription and constraints
$objectRoot
createdstringOptionalFormat: date-time
lastModifiedstringOptionalFormat: date-time
locationstringOptional
resourceTypestringOptionalKnown values: User, Group

Retrieve a single User — 200 response body — name

FieldTypePresenceDescription and constraints
$objectRoot
familyNamestringRequired within parent
givenNamestringRequired within parent

Retrieve a single User — 200 response body — phone Numbers item

FieldTypePresenceDescription and constraints
$objectRoot
primarybooleanRequired within parentDefault: false
typestringRequired within parentKnown values: home, work, other
valuestringRequired within parent

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User

FieldTypePresenceDescription and constraints
$objectRoot
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
customFieldsJSONOptional
customFields (anyOf 1)arrayAlternative
customFields (anyOf 1)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
customFields (anyOf 2)nullAlternative
customFields (anyOf 2)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item
customFieldsFlattenedJSONOptional
customFieldsFlattened (anyOf 1)objectAlternativeCustom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
customFieldsFlattened (anyOf 1).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value
customFieldsFlattened (anyOf 2)nullAlternativeCustom fields keyed by field UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
customFieldsFlattened (anyOf 2).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields Flattened null value
departmentCustomFieldsJSONOptional
departmentCustomFields (anyOf 1)objectAlternativeOrg-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).*stringAdditional keys
departmentCustomFields (anyOf 2)nullAlternativeOrg-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).*stringAdditional keys
departmentExternalIdJSONOptional
departmentExternalId (anyOf 1)stringAlternative
departmentExternalId (anyOf 2)nullAlternative
departmentExternalIdHierarchyJSONOptional
departmentExternalIdHierarchy (anyOf 1)stringAlternative
departmentExternalIdHierarchy (anyOf 2)nullAlternative
departmentHierarchyJSONOptional
departmentHierarchy (anyOf 1)stringAlternative
departmentHierarchy (anyOf 2)nullAlternative
employmentsJSONOptional
employments (anyOf 1)arrayAlternative
employments (anyOf 1)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item
employments (anyOf 2)nullAlternative
employments (anyOf 2)[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item
endDateModelOptionalExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date
hiringStatusstringOptional
isManagerbooleanOptionalDefault: false
jobProfileJSONOptionalActive 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)ModelAlternativeExpand 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)nullAlternative
organizationalStructuresFlattenedJSONOptional
organizationalStructuresFlattened (anyOf 1)objectAlternativeOrg structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
organizationalStructuresFlattened (anyOf 1).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value
organizationalStructuresFlattened (anyOf 2)nullAlternativeOrg structures keyed by structure UUID. Only present when the scimFlattenedFields feature flag is enabled.
Additional keys: see wildcard field
organizationalStructuresFlattened (anyOf 2).*ModelAdditional keysExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value
startDateJSONOptional
startDate (anyOf 1)stringAlternativeFormat: date
startDate (anyOf 2)nullAlternativeFormat: date
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative
workLocationJSONOptional
workLocation (anyOf 1)stringAlternativeThe work location label assigned to the worker's HRIS profile
workLocation (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)nullAlternative

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User custom Fields null item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptional
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)nullAlternative

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item

FieldTypePresenceDescription and constraints
$objectRoot
activebooleanOptionalDefault: false
contractIdstringOptional
contractTypeJSONOptional
contractType (anyOf 1)stringAlternative
contractType (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
customFieldsarrayOptionalContract-level custom fields associated with the employment
customFields[]ModelEach itemExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item custom Fields item
startDateJSONOptional
startDate (anyOf 1)stringAlternative
startDate (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative
teamModelOptionalExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User employments null item team
titleJSONOptional
title (anyOf 1)stringAlternative
title (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
dataJSONOptionalThe custom field value payload, structure varies by field type
data (anyOf 1)ModelAlternativeExpand 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)nullAlternative
idstringOptional
namestringOptional
typestringOptional

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

FieldTypePresenceDescription and constraints
$objectRootThe 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

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User end Date

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternativeKnown 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

FieldTypePresenceDescription and constraints
$objectRootActive 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.
idstringOptionalJob profile id.
jobFamilyJSONOptionalJob family of the job profile.
jobFamily (anyOf 1)ModelAlternativeExpand 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)nullAlternative
jobFamilyGroupJSONOptionalJob family group of the job family.
jobFamilyGroup (anyOf 1)ModelAlternativeExpand 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)nullAlternative
levelJSONOptional
level (anyOf 1)JSONAlternative
level (anyOf 1) (anyOf 1)integerAlternativeJob profile level.
level (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
level (anyOf 2)nullAlternativeJob profile level.
namestringOptionalJob profile name.
trackJSONOptional
track (anyOf 1)stringAlternativeJob profile track, as configured in job architecture (free text).
track (anyOf 2)nullAlternativeJob 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

FieldTypePresenceDescription and constraints
$objectRootJob family group of the job family.
idstringOptionalJob family group id.
namestringOptionalJob 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

FieldTypePresenceDescription and constraints
$objectRootJob family of the job profile.
idstringOptionalJob family id.
namestringOptionalJob family name.

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:2 0:User organizational Structures Flattened null value

FieldTypePresenceDescription and constraints
$objectRoot
externalIdHierarchiesarrayOptional
externalIdHierarchies[]stringEach item
externalIdsarrayOptional
externalIds[]stringEach item
nameHierarchiesarrayOptional
nameHierarchies[]stringEach item
namesarrayOptional
names[]stringEach item
orgStructureNamestringOptional

Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User

FieldTypePresenceDescription and constraints
$objectRoot
costCenterstringOptional
departmentstringOptional
managerModelOptionalExpand Retrieve a single User — 200 response body — urn:ietf:params:scim:schemas:extension:enterprise:2 0:User manager
organizationstringOptional

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

FieldTypePresenceDescription and constraints
$objectRoot
displayNamestringOptional
valuestringRequired within parent

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.