EIeightfold
Users

Get User

Changed on

Given a user id of a user, it returns the user object

get/api/v2/core/users/{userId}

Request

Path parameters

userIdstring required

ID of user in Eightfold

Query parameters

includestring

Include additional fields in the response. Possible values are lastLoginTimeStamp

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

verifiedAtinteger nullable

Verified at timestamp of the User

createdAtinteger nullable

Create timestamp of the User

managerEmailstring nullable

Email of User's Manager

rolesstring[] nullable

Roles of a user

profileIdstring nullable

ProfileId of User

firstNamestring

First Name of User

companystring nullable

Company of User

emailstring required

Email of User

timezoneNamestring nullable

Timezone name for a user

localLoginEnabledboolean nullable

Whether password/local login is enabled for the user

defaultAccessModestring

Access Mode of User

titlestring nullable

Title of User

idstring nullable

Id of an User

languagestring nullable

Language preference of the user

timezoneOffsetinteger nullable

Timezone offset for a User

updatedAtinteger nullable

Update timestamp of the User

hrbpDataobject nullable

HRBP Data of an User

uuidstring nullable

External unique identifier such as UUID, Corporate ID and Employee ID

isDisabledboolean nullable

If user is disabled or not

lastLoginTimeStampinteger nullable

Last login time stamp of a user

ssoEnabledboolean nullable

Whether SSO is configured/enforced for the user

managerstring nullable

Manager of User

lastNamestring

Last Name of User

Changes

  • 9a8b3a927e93Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status