familyName | User’s family (or last) name. | string | "smith" |
givenName | User’s given (or first) name. | string | "jane" |
language | User’s preferred language, as per ISO 639-1:2002. | string | "en" |
emails | List that contains one or more email addresses registered as Authentication Identifiers (authN IDs). Each object in the list includes: | array of email objects | |
id | Unique internal identifier for the email registered as an authN ID. | integer | 257 |
email | Actual email address value. | string | "jane_smith@email.ca" |
status | Current status of the authN ID. Possible statuses include:- activated: authN ID is fully registered and verified. - activating: authN ID is registered but needs to be verified. - pending: authN ID is registered to replace another authN ID but needs to be verified. | string | "activated" |
mfaOption | Whether this authN ID is registered as an MFA option for the user. | boolean | "false" |
mobiles | List that contains one or more mobile numbers that are registered as Authentication Identifiers (authN IDs). Each object includes: | array of mobile objects | |
id | Unique internal identifier for the mobile registered as an authN ID. | integer | 834328 |
number | Actual mobile number value. | string | "1234567890" |
status | Current status of the authN ID. Possible statuses include:- activated: authN ID is fully registered and verified. - activating: authN ID is registered but needs to be verified. - pending: authN ID is registered to replace another authN ID but needs to be verified. | string | "activating" |
country | Country code, as per ISO 3166. | string | "CA" |
mfaOption | Whether this authN ID is registered as an MFA option for the user. | boolean | true |
aliases | List of one or more aliases registered as an AuthN ID. Each object includes: | Array of alias objects. | |
id | Unique internal identifier for the email registered as an authN ID. | string | 19743 |
alias | Actual alias value. | string | "skippy" |
preferredNotificationChannel | User’s preferred external channel to receive notifications (e.g. email or SMS), taken from one of the registered authN IDs. Value format is: {object}.{propertyName},{id}.For example, “mobiles.number,723419” means that the client application should look inside the mobiles object, and inspect the number value where the corresponding id is 723419. | string | "emails.email,02781" |
branding | Indicator of branding to be used on a per-user level (e.g. differentiating between an operator’s main brand and a discount brand).Applicable to service providers with more than one brand, if they prefer to render a separate, distinct UI. | string | "Maple" |
socialConnections | List of user’s connections to social providers. Each object includes: | array of SocialConnection objects | |
id | Digital Identity Management’s unique internal identifier for the connection between this User and the given social account. This ID is distinct from the socialId provided by the social provider. | integer | 597 |
socialId | External unique identifier of the social account profile. In other words, this is the user’s profile ID with the social provider.This number is provided to Digital Identity Management during the initial Digital Identity Management-to-Social Account association. | string | |
providerId | The name of the social provider in this connection. | string | "Facebook" |
Secret2faTotp | The shared secret between Digital Identity Management for this User and an Authenticator App that the User has registered for Multi-factor Authentication. The value for this is obfuscated. | string | |
domain | The domain which the user onboarded onto Digital Identity Management from. Useful as an alternate form to determine appropriate branding. | string | "int.m1amdocs.com" |