Realms

Application Level Login

An application level OAuth2 token request

Authentication type: None

POST https://kapip-s.hilton.io/hospitality-partner/v2/realms/applications/token

tokenRequest required OAuth2 Token Request OAuth2TokenRequest-Authorizations

Responses

200 Successful operation OAuth2TokenResponse-Authorizations
400 Login Failed Response 400
401 Login Failed Response 401

Response 400

authnErrorCode optional Error token with additional detail over the base error.
Example : "string"		 string
authnErrorMessage optional Human readable error description with additional detail over the base error.
Example : "string"		 string
error optional A token that indicates the error that occurred.
Example : "string"		 string
error_description optional Human readable error description.
Example : "string"		 string
error_uri optional An optional URL for the user to go to to address the issue.
Example : "string"		 string

Response 401

authnErrorCode optional Error token with additional detail over the base error.
Example : "string"		 string
authnErrorMessage optional Human readable error description with additional detail over the base error.
Example : "string"		 string
error optional A token that indicates the error that occurred.
Example : "string"		 string
error_description optional Human readable error description.
Example : "string"		 string
error_uri optional An optional URL for the user to go to to address the issue.
Example : "string"		 string

Example Request

https://kapip-s.hilton.io/hospitality-partner/v2/realms/applications/token
{
  "client_secret" : "string",
  "client_id" : "string"
}

Example Response

{
  "access_token" : "string",
  "refresh_token" : "string",
  "UserClaims" : {
    "hhonorsNumber" : "string",
    "domainUserName" : "string",
    "confNumber" : "string",
    "lastName" : "string",
    "hltInnCode" : "string",
    "keyIdentifier" : "string",
    "hltId" : "string",
    "hltInnCodes" : "string",
    "arrivalDate" : "string",
    "firstName" : "string",
    "emailAddress" : "string",
    "phoneNumber" : "string",
    "tier" : "string",
    "userRealm" : "string",
    "partnerId" : 0,
    "departureDate" : "string",
    "guestId" : 0,
    "username" : "string"
  },
  "scope" : "string",
  "token_type" : "string",
  "expires_in" : 0
}

Definitions

OAuth2TokenRequest-Authorizations

client_id required The OAuth2 client_id of the application on which the user is attempting to login.
Example : "string"		 string
client_secret required The OAuth2 client_secret of the application on which the user is attempting to login.
Example : "string"		 string

OAuth2TokenResponse-Authorizations

UserClaims optional Example : UserClaims-Authorizations UserClaims-Authorizations
access_token required The OAuth2 access token.
Example : "string"		 string
expires_in optional The number of seconds until the OAuth2 token will expire.
Example : 0		 integer(int32)
refresh_token optional The OAuth2 refresh token.
Example : "string"		 string
scope optional The scope associated with the OAuth2 Token.
Example : "string"		 string
token_type optional The type of token that is being returned.
Example : "string"		 string

UserClaims-Authorizations

arrivalDate optional The arrival date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"		 string(date)
confNumber optional Confirmation Number
Example : "string"		 string
departureDate optional The departure date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"		 string(date)
domainUserName optional The domain associated with the authenticated user. Current valid values are (“guests”, “partners”, and “corp”).
Example : "string"		 string
emailAddress optional Email address
Example : "string"		 string
firstName optional Guest first name.
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"		 string
guestId optional Internal id assigned to a new Guest Profile.
Example : 0		 integer(int64)
hhonorsNumber optional Hilton Honors Number.
Pattern : ^\d{1,24}$
Example : "string"		 string
hltId optional IDM Hilton Id.
Pattern : ^[A-Fa-f0-9]{8}$
Example : "string"		 string
hltInnCode optional Property Code
Pattern : ^[A-Z]{4,5}$
Example : "string"		 string
hltInnCodes optional The list of secondary Property Codes associated with the user.
Pattern : ^[A-Z]{4,5}(,[A-Z]{4,5})*$
Example : "string"		 string
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
lastName optional Guest last name
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"		 string
partnerId optional The Partner ID associated with a user from the partner realm
Example : 0		 integer(int32)
phoneNumber optional Phone number
Pattern : ^[0-9]{7,15}$
Example : "string"		 string
tier optional HHonors tier. ( B = Blue, S = Silver, G = Gold, D = Diamond, L = Lifetime Diamond ).
Example : "string"		 enum (B, S, G, D, L)
userRealm optional The realm name of the user associated with the token
Example : "string"		 string
username optional The user name of the user associated with the token. Allows standard
guest user names or Honors numbers.
Pattern : ^[a-zA-Z][0-9a-zA-Z@._]{3,31}$|^\d{1,24}$
Example : "string"		 string