users

Get details of a user with given id

get/users/{id}

Request

  • Base URL
    https://api.smartrecruiters.com/user-api/v201804
  • URL
    https://api.smartrecruiters.com/user-api/v201804/users/{id}
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: users_read

Response

User details

emailstring email
firstNamestring name required
lastNamestring name required
externalDatastring nullable
ssoIdentifierstring nullable
ssoLoginMode'SSO' | 'PASSWORD' nullable

User level login mode setting. Possible values are:

  • SSO - user can login only through SSO
  • PASSWORD - user can login only by password

Notice: This setting CAN be configured always, but it will be respected only if:

  • SSO is enabled at company level
  • employee level SSO configuration functionality is enabled for company
idstring
activeboolean
updatedOnstring date-time
personIdExternalstring nullable

External person ID from the managing system (e.g. SuccessFactors personIdExternal)

Changes

No recorded changes to this operation across all 1 revision of this API.