> For the complete documentation index, see [llms.txt](https://docs.authgear.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.authgear.com/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/user-profiles/access-user-profiles.md).
# Access User Profiles
Learn how to access User Profiles
To access any of the applications in your Authgear account, each user must have a profile in the account. [User Profiles](/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/user-management/user-profile.md) contain information about your users such as name, contact information, and [standard](/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/user-management/user-profile.md#standard-attributes) and[ custom attributes](/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/user-management/user-profile.md#custom-attributes) you define. You can retrieve and manage user profiles in the following ways:
* [From the Authgear UI portal](#id-1.-access-user-profiles-from-the-authgear-ui-portal).
* [From your apps using Authgear SDKs](#id-2.-access-user-profiles-from-apps-using-authgear-sdks).
* [From Admin API](#id-3.-access-user-profiles-from-admin-api).
* [From the OIDC UserInfo endpoint](#id-4.-access-user-profiles-from-the-oidc-userinfo-endpoint).
* [Embed User Profiles into JWT](#id-5.-embed-user-profiles-into-jwt)
{% hint style="info" %}
The standard attributes in UserProfile in OIDC are a standardized schema for representing the end-users identity information and you can not add or delete them. To introduce additional attributes, use custom attributes.
{% endhint %}
### Prerequisites
* **An Authgear account:** You need an Authgear account to follow this guide. If you don't have one, you can[ create it for free](https://accounts.portal.authgear.com/signup) on the Authgear website.
* **A Registered App:** You need a [registered application](https://docs.authgear.com/get-started/website#setup-application-in-authgear) (client) in Authgear.
### 1. Access user profiles from the Authgear UI portal
It is the fastest and easiest way to view user profiles and manage them.
Expand this to see the guide
To view see user profile of a specific user:
1. Go to the [Authgear Portal](https://portal.authgear.com/).
2. Navigate to **User Management.**
3. Choose a user you would like to view a profile.
4. On the **User Details** page, you will see the **Profile** tab.
To manage access for standard attributes for all users:
Go to **Portal** > **User Profile** > **Standard Attributes**
.png?alt=media&token=66487b34-90b3-48ba-9406-aa86dd1de44f)
To manage access and add new custom attributes for all users:
Go to **Portal** > **User Profile** > **Custom Attributes** and click **Add New Attribute**
.png?alt=media&token=3f9fcf89-3c9d-43f1-9a26-ca7b4debef59)
### 2. Access user profiles from apps using Authgear SDKs
Once Authgear completes authentication and returns control to your application, it provides the user profile to the application. Most developers prefer to use the **Authgear SDKs** to get the UserInfo object using the **fetch user info** function. To start using this function read [getting started guides](/~/changes/S9PzpQKqtjCE4EDWHGO4/get-started/start-building.md) relevant to the **SDK of your choice**. Here are some code snippets for different SDKs:
{% tabs %}
{% tab title="JavaScript" %}
```javascript
try{
const userInfo = await authgear.fetchUserInfo()
} catch(e) {
// failed to fetch user info
}
```
{% endtab %}
{% tab title="iOS" %}
```swift
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
}
```
{% endtab %}
{% tab title="Android" %}
```kotlin
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
}
});
```
{% endtab %}
{% tab title="Flutter" %}
```dart
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;
```
{% endtab %}
{% tab title="Xamarin" %}
```csharp
try
{
var userInfo = await authgear.FetchUserInfoAsync()
}
catch
{
// failed to fetch user info
// the refresh token maybe expired or revoked
}
```
{% endtab %}
{% endtabs %}
### 3. Access user profiles from Admin API
Authgear provides an [Admin API](/~/changes/S9PzpQKqtjCE4EDWHGO4/reference/apis/admin-api.md) GraphQL endpoint that allows applications and services to access and manipulate the User Profile object. The [API Explorer](/~/changes/S9PzpQKqtjCE4EDWHGO4/reference/apis/admin-api.md#api-explorer) lets users interactively explore the Admin API. With the API Explorer, you can search for users' profiles or update their standard or custom attributes. See the example steps of how to achieve this below:
Expand this to see the guide
1. Go to the **Portal**.
2. Navigate to the **Advanced** -> **Admin API.**
3. Find a section called **GraphiQL Explorer.**
4. Click on the **GraphiQL tool** link.
The explorer will be opened in a separate browser tab.
5. Search for a user by `email`and put in your query `standardAttributes` and `customAttributes`. For example:
```json5
query {
users(
searchKeyword: "bobur@oursky.com"
) {
edges {e
node {
standardAttributes
customAttributes
}
}
}
}
```
### 4. Access user profiles from the OIDC UserInfo endpoint
The OpenID Connect (OIDC) [UseInfo](/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/user-management/user-profile.md#userinfo-endpoint) endpoint is a protected resource that provides information about a user when a service provider presents an access token that has been issued by your **Authgear Token endpoint**. The scopes in the access token specify the user attributes that are returned in the response of the user info endpoint. It is important to note that the `openid` scope must be one of the access token claims.
To access a user's profile using the UserInfo endpoint of OpenID Connect, you need to follow these steps:
Expand this to see the guide
To access a user profile endpoint, you need to have a JWT access token in the header of a request to `/oauth2/userinfo`
We are going to use **cURL** commands in our API calls or you can also use [Postman](https://www.postman.com/) or similar tools.
**Prerequisites**
* Make sure that you have a registered app type of **OIDC Client Application** in Authgear Portal.
**Step 1: Obtain the necessary parameters**
Open your **OpenID Auth App** configuration, and find **Client ID**, **Client Secret**, and check **Authorization**, and **Token** endpoints. You will use them in the next steps.
**Step 2: Construct the authorization endpoint URL**
The URL for this endpoint is usually provided by the authorization server and includes parameters specifying the requested `scope`, `client_id`, and response\_type. Here's an example URL for the authorization endpoint:
```bash
https:///oauth2/authorize?client_id={YOUR_CLIENT_ID}&response_type=code&scope=openid
```
Replace `` with your Authgear server's domain, `YOUR_CLIENT_ID` with your application's Client ID from **OpenID App.**
**Step 3: Redirect the user to the authorization endpoint**
Next, you need to redirect the user to the authorization endpoint. You can just put the URL in your browser and log in with a user credential you are interested to retrieve an access token for. After successful authentication and consent, the Authgear will redirect the user back to your specified redirect URI, including an **authorization code** as a query parameter. You will need the code in the next step
**Step 4: Obtain an access token**
You need to make a request to the **OpenID App's Token endpoint** to exchange the **authorization code** we retrieved in the previous step for an access token.
* The token endpoint URL is usually something like `https:///oauth2/token`.
* Include parameters such as `grant_type=authorization_code`, `code=AUTHORIZATION_CODE`, `client_id=YOUR_CLIENT_ID`, `client_secret=YOUR_CLIENT_SECRET`, and `redirect_uri=YOUR_REDIRECT_URI`.
* Make a POST request to the token endpoint to obtain the access token.
```bash
curl --request POST \
--url 'https:///oauth2/token' \
--header 'content-type: application/x-www-form-urlencoded' \
--data grant_type=authorization_code \
--data code={YOUR_AUTHORIZATION_CODE} \
--data redirect_uri={YOUR_REDIRECT_URI} \
--data 'client_id={YOUR_CLIENT_ID}' \
--data client_secret={YOUR_CLIENT_SECRET} \
--data scope=openid
```
**Step 5: Make a request to the Userinfo endpoint**
Once you have obtained a **JWT access token**, you can use it to make a request to the Userinfo endpoint. The request to the Userinfo endpoint should include the access token in the `Authorization` header using the `Bearer` scheme.
```bash
curl -X GET \
-H "Authorization: Bearer ACCESS_TOKEN" \
https:///userinfo
```
If you are using Postman, you can enable the Authorization type of OAuth2.0, provide the necessary information for getting the authorization code, obtaining an access token and use that token to request the Userinfo endpoint:
See a detailed explanation of the structure and fields included in the response of the UserInfo endpoint [here](/~/changes/S9PzpQKqtjCE4EDWHGO4/reference/apis/oauth-2.0-and-openid-connect-oidc/userinfo.md).
### 5. Embed User Profiles into JWT
Authgear WebHooks makes it possible to embed the standard attributes and custom attributes for a user's profile into the OIDC JSON Web Token (JWT). Hence, you access both profile attributes in the JWT returned to your OIDC client without making another call to the UserInfo endpoint.
See our post about how to [Add custom fields to a JWT Access Token](/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/integration/add-custom-fields-to-a-jwt-access-token.md) to learn more.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.authgear.com/~/changes/S9PzpQKqtjCE4EDWHGO4/how-to-guide/user-profiles/access-user-profiles.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.