v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Users

Patch User

Given a user id of a user with user data, it patches the user object. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

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

Path parameters

userIdstring required

EF Entity ID of user

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

Request body

uuidstring nullable

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

timezoneNamestring nullable

timezone name fr a user

timezoneOffsetinteger nullable

timezone offset for a User

rolesstring[] nullable

Roles of a user

profileIdstring nullable

ProfileId of User

defaultAccessModestring required

Access Mode of User

isDisabledboolean nullable

Email of User

firstNamestring nullable

First Name of User

companystring nullable

company of User

hrbpDataobject nullable

HRBP Data of an User

lastNamestring nullable

Last Name of User

titlestring nullable

title of User

Response

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

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

managerstring nullable

Manager of User

lastNamestring

Last Name of User