authenticateCredentials request
The authenticateCredentials request authenticates a user credential or credentials.
Send the request to: https://userservices-auth.vip.symantec.com/vipuserservices/AuthenticationService_1_10
authenticateCredentials
input fields provides details about the authenticateCredentials
input fields.Input Field | Required? | Type | Purpose |
|---|---|---|---|
requestId | Y | string | A unique identifier of the request for the enterprise application. The request ID accepts from 4 to 40 alphanumeric characters and underscores. This identifier may be useful for troubleshooting purposes. |
activate | N | boolean | Activates a credential. If otpAuthData is provided, it consumes the OTP to authenticate. If pushAuthData is used, sends a push notification to the credential for authentication. |
credentials :credentialId | Y | list | List of credentials, which in turn is an object of credentialId and credentialType . |
credentials :credentialType | Y | string | Identifies the credential type:
|
otpAuthData :otp | N | string | The one-time security code that is generated by the user’s credential. You must use this value or pushAuthData , but cannot use both. |
pushAuthData :displayParameters | N | list | Passes and displays content to users in the push notification. You can customize display messages up to 250 characters. The values must be UTF-8 encoded to support internationalization. However, some phones may not display complete messages. The following keys are currently supported: This input field contains parameters that define the push notification that is sent to the user’s push-capable mobile device. You must use this value or otpAuthData , but cannot use both.
|
pushAuthData :encryptedDisplayParameters | N | list | Passes and displays content to users in the push notification. Use encryptedDisplayMessage instead of displayParameters to send the encrypted message only if you have integrated VIP SDK version 3.0.2 or later with your client app.VIP sends the encrypted version of your transaction message to the user's mobile device. Your client app decrypts it on the mobile device using the private key assigned to that mobile device. See the Symantec VIP Credential Development Kit Application Developer's Guide at the Broadcom TechDocs portal for full details on using the VIP SDK to encrypt transactions.The following keys are supported:
|
pushAuthData :requestParameters | N | list | The following keys are supported:
|
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 credential types that can be validated with this request. This level must match an authentication level configured in VIP Manager.
|
See: