POST
/
User
/
auth
/
{provider}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

provider
string
required

Auth provider. Optional By default is null for the built-in provider

Body

email
string | null
entry
string | null

Identifier for entry point originating the request (used by front-end apps)

entryType
integer | null

Type of entry identifier: 0 - partner, 2 - paypoint
used by front-end apps, required if an Entry is indicated.

psw
string | null
userId
integer | null
userTokenId
string | null

Response

200 - application/json
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

mfa
boolean | null

When true, multi-factor authentication (MFA) is enabled.

mfaMode
string

The mode of multi-factor authentication used.

mfaValidationCode
string

The validation code for multi-factor authentication, typically a hash or similar encrypted format.

responseData
string

Data returned by the response, masked for security.

responseText
string | null

Response text for operation: 'Success' or 'Declined'.