Response Body Schema
resultsarray<object>
results. credentialsarray<object>Required
results. idstringRequired
results. last_ipstringRequired
results. blockedboolean
Whether this End-User is blocked or not. If true
End-User will not be able to login.
results. emailstring
End-User's e-mail address.
results. email_verifiedboolean
true
if the End-User's e-mail address has been verified; otherwise false
. If force_email_verification
is enabled in your tenant's settings, it will check this value of user while performing email verification checks.
results. identitiesarray<object>
results.identities. connectionstringRequired
Connection name
results.identities. idstringRequired
External user's id coming from the connection.
results.identities. providerstringRequired
Available Values: twilio
vonage
netgsm
3gbilisim
dataport
messagebird
custom
hotp
totp
native
expo
one-signal
aws_ses
postmark
sendgrid
sparkpost
smtp
custom-oauth2
amazon
apple
e-devlet
dribbble
dropbox
facebook
github
google
linkedin
microsoft
slack
spotify
twitter
saml
ldap
results.identities. typestringRequired
Available Values: sms
otp
push
email
social
enterprise
results.identities. user_idstringRequired
PlusAuth user's id
results.identities. detailsobjectRequired
Raw user object from the connection
results. last_loginstring
User's last login datetime in the ISO 8601 format according to universal time
results. login_attemptsinteger
Failed login attempts of user. It will reset to 0
after successful login.
results. namestring
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
results. phone_numberstring
End-User's preferred phone number. It will be stored in E.164 format.
results. phone_number_verifiedboolean
true
if the End-User's phone number has been verified; otherwise false
. If SMS MFA is enabled this value will be used to determine whether End-User has verified it's phone or not.
results. picturestring
URI reference of the End-User's profile picture.
results. usernamestring
End-User's username
results. metadataobject
Additional metadata for your End-User. It must be an object containing 10 fields at max with keys and values no more than 1024 characters. Values can be only one of the types string
, number
and boolean
. You can also use "null"
as value to make metadata consistent across other users.
results. profileobject
results.profile. addressesarray
results.profile.addresses. citystring
City or locality component.
results.profile.addresses. countrystring
Country name component.
results.profile.addresses. first_namestring
results.profile.addresses. idstring
Identifier for user address. Example: Delivery Address
, Billing Address
etc.
results.profile.addresses. is_primaryboolean
results.profile.addresses. last_namestring
results.profile.addresses. statestring
State, province, prefecture or region component.
results.profile.addresses. street_addressstring
Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newline characters.
results.profile.addresses. street_address_2string
Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newline characters.
results.profile.addresses. zip_codestring
Zip code or postal code component.
results.profile. birthdatestring
End-User's birthday. ISO 8601:2004 YYYY-MM-DD format. The year may be 0000, indicating that it is omitted. To represent only the year, YYYY format is preferred.
results.profile. family_namestring
Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
results.profile. genderstring, integer
Short code of End-User's gender.
results.profile. given_namestring
Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
results.profile. localestring
End-User's locale. For example, en-US or fr-CA.
results.profile. middle_namestring
Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
results.profile. nicknamestring
Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
results.profile. profile_pagestring
URI reference for the End-User's profile page.
results.profile. websitestring
URI reference for the End-User's Web page or blog.
results.profile. zoneinfostring
String from zoneinfo time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.