POST papi/v1/auth

Security

Anonymous API

Request Information

URI Parameters

None.

Required Headers

Name	Description	Sample	Type	Default
ConsumerId	Represents the value of the consumer id. Allow multiple values: no.	2426	integer	None

Optional Headers

Name	Description	Sample	Type	Default
ApplicationType	Represents the value of the consumer's application type. Allow multiple values: no.	1	ApplicationType	None
Accept-Language	Represents the value of the desired language for translations. Allow multiple values: yes.	es	string	en

Body Parameters

AuthRequest

Name	Type	Additional information
Username	string	Required
Password	string	Required
Algorithm	EncryptionAlgorithm	None.
IsSSOEnabled	boolean	None.
AuthType	AuthType	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "Algorithm": "None",
  "IsSSOEnabled": true,
  "AuthType": "None"
}

application/xml, text/xml

Sample:

<AuthRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Username>sample string 1</Username>
  <Password>sample string 2</Password>
  <Algorithm>None</Algorithm>
  <IsSSOEnabled>true</IsSSOEnabled>
  <AuthType>None</AuthType>
</AuthRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AuthRequest'.

Response Information

Resource Description

AuthenticatedUser

Name	Type	Additional information
UserDetails	IUserInfo	None.
PasswordHash	string	None.
PinHash	string	None.

Response Formats

application/json, text/json

Sample:

{
  "UserDetails": null,
  "PasswordHash": "sample string 1",
  "PinHash": "sample string 2"
}