authenticateUser request

authenticateUser input fields provides details about the
authenticateUser
input fields.
authenticateUser
input fields
Input Field
Required?
Type
Purpose
requestId
Y
String
A unique identifier of the request for the enterprise application.
userId
Y
String
Unique ID for the user (for example, the user email address, the user’s log-on name, or a unique ID that maps to user’s log-on name). The userId accepts 1 to 128 international characters. The user ID is not case-sensitive in look-up operations.
pin
N
String
Optional user PIN for first-factor authentication. The PIN may be 4 to 128 international characters in length, depending on restrictions of the PIN policy.
otpAuthData
otp
N
String
The one-time password (security code) generated by the user’s credential. A
authContext
N
String
A map containing the parameters that control how the authentication is performed.
VIP
User Services accepts an authentication level for the
authContext
field.
The authentication level defines the authentication methods that the user must use to authenticate. This level must match an authentication level that is configured in
VIP
Manager.
  • Key: Enter authLevel.level
  • Value: Enter the authentication level value (as an integer from 1 - 10).

Example authenticateUser request

<?xml version="1.0" encoding="UTF-8"?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <AuthenticateUserRequest xmlns="https://schemas.vip.symantec.com"> <requestId>abcd1234</requestId> <userId>John Walker</userId> <pin>1abcef</pin> <otpAuthData> <otp>123456</otp> </otpAuthData> <authContext> <params> <Key>authLevel.level</Key> <Value>1</Value> </params> </authContext> </AuthenticateUserRequest> </S:Body> </S:Envelope>