v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Users

Get User ID by User Type and Entity Id

Returns a user ID, for the specified user type and entity Id, registered in the system.

get/v1/user/user-type/{userType}/{entityId}

Path parameters

userTypestring required

The name of the user type. Available options are Talent, Manager, HCM.

entityIdstring required

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The user ID for the specified user type and entity ID.

userType'Unknown' | 'Talent' | 'Manager' | 'Hcm' | 'All'
userIdinteger

The identifier for the user.

entityIdinteger

The entity identifier for the user.