Türkçe dil desteğimiz henüz tamamlandı. Eksik sayfalar veya bölümlerle karşılaşmanız durumunda İngilizce dilini seçerek sayfanın orjinalini görebilirsiniz.

Users

PlusAuth dashboard provides you to manage your users.

Manage Users

In Dashboard > Users you can create, update and delete your users.

User Metadata

Followings are the fields of users:

FieldDescription
usernameEnd-User's username.
passwordHashed value of End-User's password.
blockedWhether End-User is blocked or not. If true End-User will not be able to login.
login_attemptsFailed login attempts of user. It resets to 0 after successful login.
saltSalt value used in computing hash of password.
funcUsed password hash function identifier. Values correspond to functions as:
- 1: bcrypt
- 2: argon2
- 3: pbkdf2
user_details.emailEnd-User's e-mail address.
user_details.nameEnd-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.
user_details.given_nameGiven 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.
user_details.family_nameSurname(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.
user_details.middle_nameMiddle 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.
user_details.nicknameCasual 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.
user_details.preferred_usernameShorthand name that the End-User wishes to be referred to in your application, such as janedoe or j.doe. This value may be any valid JSON string including special characters such as @, /, or whitespace. Note that this field is not unique and it is not checked in default login flow.
user_details.profileURL of the End-User's profile page. No format is enforced for this value but it is advised that the contents of this web page should be about the End-User.
user_details.pictureURL of the End-User's profile picture. No format is enforced for this value but it is advised that this value should refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL should specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
user_details.websiteURL of the End-User's Web page or blog. No format is enforced for this value but it is advised that this value should contain information published by the End-User or an organization that the End-User is affiliated with.
user_details.email_verifiedtrue if the End-User's e-mail address has been verified; otherwise false. If forceEmailVerification is enabled in your tenant's settings, it will check this value of user while performing email verification checks.
user_details.genderEnd-User's gender. No format is enforced for this value
user_details.birthdateEnd-User's birthday. No format is enforced for this value but it is advised to be represented as an 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. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so you should take this factor into account to correctly process the dates.
user_details.zoneinfoString from zoneinfo time zone database representing the End-User's time zone. For example, Europe/Istanbul or America/Los_Angeles.
user_details.localeEnd-User's locale. For example, en-US or tr-TR.
user_details.phone_numberEnd-User's preferred telephone number. By default sms required for MFA will be sent to this value.
user_details.phone_number_verifiedtrue 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.
user_details.metadataAdditional metadata for your End-User. It must be an object containing 10 fields at max with keys and values no more than 255 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.
user_details.address.formattedFull mailing address, formatted for display or use on a mailing label. This field may contain multiple lines, separated by newline characters.
user_details.address.street_addressFull 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.
user_details.address.localityCity or locality component.
user_details.address.regionState, province, prefecture or region component.
user_details.address.postal_codeZip code or postal code component.
user_details.address.countryCountry name component.