User Profile
The user profiles contain information about your end-users such as name, email, addresses, and unique identifier. You can manage the profiles via the Portal & Admin API. The end-users can also manage their own profile through the Profile section in the User Setting page provided by the AuthUI.
Th e UserInfo endpoint returns the Claims about the authenticated end-user, including the standard profile and custom attributes.
The
userInfo object is returned from calling fetch user info function which contains a unique identifier of the user.Key | Type | Description |
|---|---|---|
isAnonymous | boolean | |
isVerified | boolean | Indicate if the user completed the verification requirement |
sub | string | Unique identifier of the user in your Authgear project |
JavaScript
iOS
Android
Flutter
Xamarin
try{
const userInfo = await authgear.fetchUserInfo()
} catch(e) {
// failed to fetch user info
// the refresh token maybe expired or revoked
}
authgear.fetchUserInfo { userInfoResult in
// sessionState is now up to date
// it will change to .noSession if the session is invalid
let sessionState = authgear.sessionState
switch userInfoResult {
case let .success(userInfo):
// read the userInfo if needed
case let .failure(error):
// failed to fetch user info
// the refresh token maybe expired or revoked
}
authgear.fetchUserInfo(new OnFetchUserInfoListener() {
@Override
public void onFetchedUserInfo(@NonNull UserInfo userInfo) {
// sessionState is now up to date
// read the userInfo if needed
}
@Override
public void onFetchingUserInfoFailed(@NonNull Throwable throwable) {
// sessionState is now up to date
// it will change to NO_SESSION if the session is invalid
}
});
try {
UserInfo userInfo = await authgear.getUserInfo();
// read the userInfo if needed
} catch (e) {
// failed to fetch user info
// the refresh token maybe expired or revoked
}
// sessionState is now up to date
SessionState state = authgear.sessionState;
try
{
var userInfo = await authgear.FetchUserInfoAsync()
}
catch
{
// failed to fetch user info
// the refresh token maybe expired or revoked
}
The following attributes are built-in supported by Authgear. They are the set of Standard Claims defined by the OIDC specifications. Some of them are default hidden from the Admin Portal and end-users. Their visibility and mutability can be configured through the Admin Portal.
Attribute name | Default Visibility | Format |
|---|---|---|
Name | Hidden | String |
Given Name | Editable | String |
Family Name | Editable | String |
Middle Name | Hidden | String |
Nickname | Hidden | String |
Profile | Hidden | URL String |
Picture | Editable | URL String |
Website | Hidden | URL String |
Gender | Editable | male, female or Custom String |
Birthdate | Editable | Date in YYYY-MM-DD |
Timezone | Editable | |
Language | Editable | BCP47 language tag enabled by the project |
Address | Hidden | JSON Object |
The following attributes are coupled with the identities owned by the end-user. The represents the email addresses, phone numbers, or usernames the end-users are using to authenticate themselves on Authgear. If the end-user uses a third-party identity provider for authentication, these attributes will be coupled with the corresponding attributes returned by the provider.
emailemail_verifiedphone_numberphone_number_verifiedpreferred_username
You can define a set of custom attributes in the user profile. They are returned as a JSON object in under the
custom_attributes key in userInfo.{
"sub": "...",
"isAnonymous": false,
"isVerified": true,
"custom_attributes": {
...
}
}
Go to Portal > User Profile > Custom Attributes and click Add New Attribute
The attribute name consist of lowercase letters (a-z), digits (0-9) and underscore (_) only. It must start with lowercase letters (a-z), and NOT ended with an underscore (_). The default display name will be the attribute name split with underscore and in title case. e.g.
my_string will render as My String in the AuthUI Settings page.Authgear supports the following attribute types:
- String
- Number
- Integer
- Dropdown
- Phone Number
- Email Address
- URL
- Country Code
You can change the attribute name and validation settings such as min and max value. The attribute type cannot be changed once it's set. To migrate the attribute into a new type, create a new attribute, migrate the values from the old to the new one, and then change the name and access right of the old attribute to make it obsolete.
Deleting attribute is not supported. You can change the name and access rights to make an attribute obsolete.
You can arrange the attribute order by drag-and-drop the handle in the custom attribute configuration in the Portal. This will control the order of how the attributes are shown to the end-users in the AuthUI User Settings page.
The access rights for different parties on individual attributes can be configured through the Authgear Portal. Under the hood, all the attributes are available, however, they can be configured to be
hidden or read-only according to the needs of your projects to avoid confusion.These are the parties that have access to the user profile:
Through the Admin API, developers ALWAYS have full access to ALL the standard attributes and custom attributes. The Admin API allows the developer to view or edit the standard attributes and the custom attributes.
The admin user can view or edit the standard attributes via the Authgear Portal.
The session bearer is someone who has a valid session cookie or a valid access token. The standard attributes of the end-user whom the session represents can be viewed by accessing the UserInfo endpoint and the resolver endpoint. The session bearer can be the end-user, the client mobile app, or the client website.
The end-user can view or edit the standard attributes through the Profile section in the User Setting page provided by the AuthUI.
Authgear supports various social and enterprise identity providers. End-users can sign up and log in to your apps via these connections. Upon signup, these providers will return a set of user attributes about the end-user. Authgear will copy those attributes and populate the profile of the end-user.
Last modified 1mo ago