iOS SDK - Authentication Objects

Authentication Domain Objects

PDAuthenticationAdditionalData

A custom property that is relevant for the login process as specified by specific issuers or external user repositories. Typically used in SSO implementations to gain access to the user profile.

Property Description
additionalDataKey String
The name of the metadata property that this object represents, for example, hostIP.
additionalDataValue String
The value ascribed to this property for the particular provisioned account, for example, 10.9.23.65.

Authentication Message Objects

PDLoginByFederatedIdentityRequest

This request object passes the values that allow a new wallet user to register a device with the Paydiant service via federated login to an external IDP (identity provider).

Property Description
authorizationCode String
A code assigned by the issuer to the user’s profile with the IDP app that allows Paydiant to access the new user’s profile through the SSO framework.
identityProvider String
The external party through which authentication of the user credentials is validated.
additionalData Array
A set of PDAuthenticationAdditionalData instances passing property values required by the authenticating party.

PDLoginByNonceRequest

This request object passes the values that allow a new wallet user to register a device with the Paydiant service via nonce login to an external IDP (identity provider).

Property Description
nonce String
A session token generated by the IDP to allow Paydiant to access the new user’s profile through the SSO framework.
additionalData Array
A set of PDAuthenticationAdditionalData instances passing property values required by the authenticating party.

PDLoginResponse

Returned in the completion block of either the loginBY methods.

Property Description
additionalData Array
The set of PDAuthenticationAdditionalData instances representing properties relevant to the SSO authentication of the wallet device.

PDGenerateDeviceAuthenticationRequest

Passes the values required to create a device-specific authentication code maintained by the SDK for use in long-lived login sessions that facilitate device-level authentication such as Touch ID.

Property Description
userName String
In order to generate the device authentication token, the user must successfully enter the username (email) associated with the wallet.
password String
The user must also correctly enter the password corresponding to the username.
Feedback