Skip to main content
Check Temporary Key

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

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

TemporaryKey
string

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.

Domain
enum<string>

The domain for this key. Unknown if key is not valid.

Available options:
Unknown,
MailingRecipient,
FormSubmitterRecipient,
ViewTicketInCustomerCenter,
LoginCustomerCenter,
PublicFaq,
ChangePasswordCustomerCenter,
RegisterCustomerCenterEmailVerification
TargetId
integer<int32>

The primary key of the entity this temporary key is for, dependent of dmain

PersonId
integer<int32>

The person id this key is related to. May be null.

IsExpired
boolean

Whether the key is expired or not.

Payload
string

The payload for this key. May be null or empty.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.