Get Users Assigned to Role
Query Parameters
Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.
Examples: "id,created_at"
Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.
Additional query in PlusAuth Query Language format.
Response Body Schema
totalintegerZorunlu
resultsarray<object>
results. created_atstringZorunlu
Creation date in the ISO 8601 format according to universal time.
results. credentialsarray<object>Zorunlu
results. idstringZorunlu
results. last_ipstringZorunlu
results. updated_atstringZorunlu
Update date in the ISO 8601 format according to universal time.
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. connectionstringZorunlu
Connection name
results.identities. created_atstringZorunlu
Creation date in the ISO 8601 format according to universal time.
results.identities. idstringZorunlu
External user's id coming from the connection.
results.identities. providerstringZorunlu
Mevcut Değerler: twiliovonagenetgsm3gbilisimdataportmessagebirdcustomnativeplusauthaws_sespostmarksendgridsmtpcustom-oauth2amazonappledribbbledropboxfacebookgithubgooglelinkedinmicrosoftslackspotifytwittersamle-devletldap
results.identities. typestringZorunlu
Mevcut Değerler: smspushwebauthnemailsocialenterprise
results.identities. user_idstringZorunlu
PlusAuth user's id
results.identities. updated_atstring
Update date in the ISO 8601 format according to universal time.
results.identities. detailsobjectZorunlu
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<object>
results.profile.addresses. citystringZorunlu
City or locality component.
results.profile.addresses. countrystringZorunlu
Country name component.
results.profile.addresses. first_namestringZorunlu
results.profile.addresses. idstringZorunlu
Identifier for user address. Example: Delivery Address, Billing Address etc.
results.profile.addresses. is_primarybooleanZorunlu
results.profile.addresses. last_namestringZorunlu
results.profile.addresses. statestringZorunlu
State, province, prefecture or region component.
results.profile.addresses. street_addressstringZorunlu
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_2stringZorunlu
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_codestringZorunlu
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
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.