Get user

Updated:

GET/scim/{connection_id}/users/{id}

Parameters

connection_idstring required
ID of the connection
idstring required
ID of the User

Returns

Response fieldTypeRequiredDescription
idstringNo
schemasenumNoValues: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User, urn:ietf:params:scim:schemas:extension:peakon:2.0:User
externalIdstringNo
userTypestringNo'Employee','Super Admin', 'General Admin', 'Account Manager', 'User Manager', 'Workflow Manager', 'Experience Manager', 'Author','Reporter','Contractor,'Intern','Temp','External','Unknown']
userNamestringNo
nameobjectNo
name.formattedstringNo
name.familyNamestringNo
name.givenNamestringNo
name.middleNamestringNo
name.honorificPrefixstringNo
name.honorificSuffixstringNo
displayNamestringNo
nickNamestringNo
profileUrlstringNo
titlestringNo
preferredLanguagestringNo
localestringNo
timezonestringNo
activebooleanNo
passwordstringNo
phoneNumbersScimPhoneNumber[]No
phoneNumbers[].typeenumNoValues: work, home, other, mobile, fax, pager
phoneNumbers[].valuestringNo
phoneNumbers[].displaystringNo
phoneNumbers[].primarybooleanNo
emailsScimEmail[]No
emails[].typeenumYesValues: work, home, other
emails[].valuestringNo
emails[].primarybooleanNo
emails[].displaystringNo
imsScimIms[]No
ims[].typeenumNoValues: aim, qtalk, icq, xmpp, msn, skype, qq, yahoo
ims[].valuestringNo
ims[].displaystringNo
ims[].primarybooleanNo
photosScimPhoto[]No
photos[].valuestringNoURL
photos[].displaystringNo
photos[].typeenumNoValues: photo, thumbnail
photos[].primarybooleanNo
addressesScimAddress[]No
addresses[].formattedstringNo
addresses[].streetAddressstringNocould be multi-line
addresses[].localitystringNocity
addresses[].regionstringNostateprovince
addresses[].postalCodestringNo
addresses[].countrystringNo
addresses[].typeenumNoValues: work, home, other
groupsScimUserGroups[]No
groups[].valuestringYesID
groups[].$refstringNo
groups[].displaystringNo
groups[].typeenumNoValues: direct, indirect
entitlementsScimEntitlement[]No
entitlements[].valuestringYes
entitlements[].displaystringNo
entitlements[].typestringNo
entitlements[].primarybooleanNo
rolesScimRole[]NoStudent, Faculty, ...
roles[].valuestringYesvalue of the role
roles[].displaystringNo
roles[].typestringNo
roles[].primarybooleanNo
x509CertificatesScimRole[]No
x509Certificates[].valuestringYesvalue of the role
x509Certificates[].displaystringNo
x509Certificates[].typestringNo
x509Certificates[].primarybooleanNo
urn:ietf:params:scim:schemas:extension:enterprise:2.0:UserobjectNoan organization.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.employeeNumberstringNo
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.costCenterstringNoIdentifies the name of a cost center.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.organizationstringNoIdentifies the name of an organization.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.divisionstringNoIdentifies the name of a division.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.departmentstringNoIdentifies the name of a department.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.managerScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_managerNo"id" attribute of another User.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.valuestringNoThe "id" of the SCIM resource representing the user's manager. RECOMMENDED.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.managerIdstringNoalias for value?
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.$refstringNoThe URI of the SCIM resource representing the User's manager. RECOMMENDED.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.displayNamestringNoThe displayName of the user's manager. This attribute is OPTIONAL, and mutability is "readOnly".
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.typeenumNoValues: direct, indirect
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagersScimManager[]No
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].valuestringNoThe "id" of the SCIM resource representing the user's manager. RECOMMENDED.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].managerIdstringNoalias for value?
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].$refstringNoThe URI of the SCIM resource representing the User's manager. RECOMMENDED.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].displayNamestringNoThe displayName of the user's manager. This attribute is OPTIONAL, and mutability is "readOnly".
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].typeenumNoValues: direct, indirect
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.levelstringNo
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.startDatestring (date-time)No2011-03-25
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.endDatestring (date-time)No2022-02-25
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.birthdaystring (date-time)No1985-07-20
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.genderenumNoValues: male, female
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.locationstringNoBerlin
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.currencystringNoUser currency
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:UserobjectNo
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.startDatestring (date-time)No"2022-03-08",
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.birthDatestring (date-time)No"1987-10-06",
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.genderenumNoValues: male, female
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.sexualOrientationenumNoValues: Queer, Heterosexual, Straight
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.ethnicityenumNoValues: Caucasian, East Asian, Middle Eastern, Black, Biracial (South Asian & Caucasian), Filipino, South Asian, Indian, White, Asian
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.People Manager (Reviews)stringNo'People Manager',
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Salary InformationstringNo'130000',
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Remote Work - LocationstringNo'Ontario',
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Job LevelstringNo'M3',
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Sub DepartmentsstringNo
urn:ietf:params:scim:schemas:extension:peakon:2.0:UserobjectNo
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.GenderenumNoValues: Female, Male
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.TeamstringNo
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.ManagerstringNo
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.Date of Birthstring (date-time)No

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/scim/5de520f96e439b002043d8dc/users/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },

};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?