Internal System Info | Hilton Dev Portal for documentation

Internal System Info

Retrieves details of the currently authenticated user.

This method provides a simple endpoint that may be used do determine details of the currently authenticated principle.

Authentication type: Application & Application User

GET https://kapip-s.hilton.io/hospitality-partner/v2/inf/whoami

Responses

200

successful operation

WhoAmIReply-InfCore

Example Request

https://kapip-s.hilton.io/hospitality-partner/v2/inf/whoami

Example Response

{
  "hltInnCode" : "string",
  "keyIdentifier" : "string",
  "hltId" : "string",
  "roles" : [ {
    "description" : "A single or comma separated list of groups/roles assigned to a user."
  } ],
  "hltAppAccess" : [ {
    "description" : "A single or comma separated list of groups/roles assigned to a user."
  } ],
  "hltInnCodes" : [ {
    "description" : "Property Code"
  } ],
  "userRealm" : "string",
  "userType" : "string",
  "partnerId" : 0,
  "applicationId" : "string",
  "guestId" : 0,
  "applicationName" : "string",
  "username" : "string"
}

Definitions

propCode-InfCore

Property Code

Type : string

role-InfCore

A single or comma separated list of groups/roles assigned to a user.

Type : string

WhoAmIReply-InfCore

Details of the currently authenticated principle.

applicationId	optional	Unique ID of the OAuth 2 application for which the authentication token was generated. Example : `"string"`	string
applicationName	optional	The name of the application for which the authentication token was generated. Example : `"string"`	string
guestId	optional	Internal id assigned to a new Guest Profile. Example : `0`	integer(int64)
hltAppAccess	optional	Example : `role-InfCore`	< role-InfCore > array
hltId	optional	IDM Hilton Id. Example : `"string"`	string
hltInnCode	optional	Property Code Pattern : ^[A-Z]{4,5}$ Example : `"string"`	string
hltInnCodes	optional	Example : `propCode-InfCore`	< propCode-InfCore > array
keyIdentifier	optional	The most appropriate unique identifier from a particular userRealm to be used as a foreign key for the user. May duplicate other values contained in the JWT token (ie guestId, hltId, etc.) Example : `"string"`	string
partnerId	optional	The Partner ID associated with a user from the partner realm Example : `0`	integer(int32)
roles	optional	Example : `role-InfCore`	< role-InfCore > array
userRealm	optional	The realm name of the user associated with the token Example : `"string"`	string
userType	optional	Defines the type of user that authenticated through the API. “APPLICATION” or “APPLICATION_USER”. Example : `"string"`	string
username	optional	The user name of the user associated with the token Example : `"string"`	string