Check Temporary Key
Check a temporary key for validity, and in case it is valid, return its domain, targetId and personId
NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
TemporaryKey
CheckTemporaryKey: Check a temporary key for validity, and in case it is valid, return its domain, targetId and personId
Response
OK
The fields returned when checking a temporary key Carrier object for TemporaryKeyInfo. Services for the TemporaryKeyInfo Carrier is available from the Person Agent.
The domain for this key. Unknown if key is not valid.
Unknown, MailingRecipient, FormSubmitterRecipient, ViewTicketInCustomerCenter, LoginCustomerCenter, PublicFaq, ChangePasswordCustomerCenter, RegisterCustomerCenterEmailVerification The primary key of the entity this temporary key is for, dependent of dmain
The person id this key is related to. May be null.
Whether the key is expired or not.
The payload for this key. May be null or empty.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
NSPersonAgentCreate Temporary KeyTemporaryKey tableNSTemporaryKeyInfoCreate Temporary Key With PayloadDelete Temporary Keys Of Domain