İçeriğe geç
Geliştiriciler
Sonuç bulunamadı.

Bu sayfanın Türkçe çevirisi henüz tamamlanmadı, bu yüzden İngilizce dilinde görüntülemektisiniz.

Get User

Scopes
read:user

Path Parameters

user_id
string
Zorunlu

User identifier

GET
/users/{user_id}
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
200
Loading...

Response Body Schema

created_at
string
Zorunlu

Creation date in the ISO 8601 format according to universal time.

credentials
array<object>
Zorunlu
id
string
Zorunlu
length
0-256
last_ip
string
Zorunlu
updated_at
string
Zorunlu

Update date in the ISO 8601 format according to universal time.

blocked
boolean

Whether this End-User is blocked or not. If true End-User will not be able to login.

email
string
length
0-256

End-User's e-mail address.

email_verified
boolean

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.

identities
array<object>
identities.
connection
string
Zorunlu
length
0-64

Connection name

identities.
created_at
string
Zorunlu

Creation date in the ISO 8601 format according to universal time.

identities.
id
string
Zorunlu
length
0-256

External user's id coming from the connection.

identities.
provider
string
Zorunlu

Mevcut Değerler: twiliovonagenetgsm3gbilisimdataportmessagebirdcustomnativeplusauthaws_sespostmarksendgridsmtpcustom-oauth2amazonappledribbbledropboxfacebookgithubgooglelinkedinmicrosoftslackspotifytwittersamle-devletldap

identities.
type
string
Zorunlu

Mevcut Değerler: smspushwebauthnemailsocialenterprise

identities.
user_id
string
Zorunlu
length
0-256

PlusAuth user's id

identities.
updated_at
string

Update date in the ISO 8601 format according to universal time.

identities.
details
object
Zorunlu

Raw user object from the connection

last_login
string

User's last login datetime in the ISO 8601 format according to universal time

login_attempts
integer
min0
max
20000

Failed login attempts of user. It will reset to 0 after successful login.

name
string
length
0-256

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.

phone_number
string
length
0-32

End-User's preferred phone number. It will be stored in E.164 format.

phone_number_verified
boolean

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.

picture
string
length
0-1024

URI reference of the End-User's profile picture.

username
string
length
0-256

End-User's username

metadata
object

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.

profile
object
profile.
addresses
array<object>
profile.addresses.
city
string
Zorunlu
length
0-96

City or locality component.

profile.addresses.
country
string
Zorunlu
length
0-64

Country name component.

profile.addresses.
first_name
string
Zorunlu
length
0-64
profile.addresses.
id
string
Zorunlu
length
0-48

Identifier for user address. Example: Delivery Address, Billing Address etc.

profile.addresses.
is_primary
boolean
Zorunlu
profile.addresses.
last_name
string
Zorunlu
length
0-64
profile.addresses.
state
string
Zorunlu
length
0-96

State, province, prefecture or region component.

profile.addresses.
street_address
string
Zorunlu
length
0-1024

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.

profile.addresses.
street_address_2
string
Zorunlu
length
0-1024

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.

profile.addresses.
zip_code
string
Zorunlu
length
0-12

Zip code or postal code component.

profile.
birthdate
string
length
0-32

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.

profile.
family_name
string
length
0-256

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.

profile.
gender
string
length
0-1

Short code of End-User's gender.

profile.
given_name
string
length
0-256

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.

profile.
locale
string
length
0-12

End-User's locale. For example, en-US or fr-CA.

profile.
middle_name
string
length
0-256

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.

profile.
nickname
string
length
0-256

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.

profile.
profile_page
string
length
0-256

URI reference for the End-User's profile page.

profile.
website
string
length
0-256

URI reference for the End-User's Web page or blog.

profile.
zoneinfo
string
length
0-36

String from zoneinfo time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.