Get a User

Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see Retrieve Users with the Get Users Endpoint.

GET https://{tenantDomain}/api/v2/users/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.GetAsync(
            id: "id",
            request: new GetUserRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.GetUserRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Users.Get(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.GetUserRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.users().get(
            "id",
            GetUserRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\Requests\GetUserRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->get(
    'id',
    new GetUserRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.users.get(
    id="id",
    fields="fields",
    include_fields=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.users.get(
  id: "id",
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.get("id", {
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.get("id", {
        fields: "fields",
        includeFields: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/users/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "email": "[e-mail]",
  "email_verified": false,
  "username": "johndoe",
  "phone_number": "[phone]",
  "phone_verified": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "identities": [
    {
      "connection": "<string>",
      "user_id": "abc",
      "isSocial": true,
      "access_token": "<string>",
      "access_token_secret": "<string>",
      "refresh_token": "<string>",
      "profileData": {
        "email": "<string>",
        "email_verified": true,
        "name": "<string>",
        "username": "johndoe",
        "given_name": "<string>",
        "phone_number": "<string>",
        "phone_verified": true,
        "family_name": "<string>"
      }
    }
  ],
  "app_metadata": {},
  "user_metadata": {},
  "picture": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "multifactor": [
    "<string>"
  ],
  "multifactor_last_modified": "2023-11-07T05:31:56Z",
  "last_ip": "<string>",
  "last_login": "2023-11-07T05:31:56Z",
  "last_password_reset": "2023-11-07T05:31:56Z",
  "logins_count": 123,
  "blocked": true,
  "given_name": "<string>",
  "family_name": "<string>"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

ID of the user to retrieve.

クエリパラメータ

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields · boolean

Whether specified fields are to be included (true) or excluded (false).

レスポンス

200

application/json

User successfully retrieved.

user_id · string · デフォルト: auth0|507f1f77bcf86cd799439020

ID of the user which can be used when interacting with other APIs.

email · string<email> · デフォルト: [e-mail]

Email address of this user.

email_verified · boolean · デフォルト: false

Whether this email address is verified (true) or unverified (false).

username · string · デフォルト: johndoe

Username of this user.

phone_number · string · デフォルト: [phone]

Phone number for this user. Follows the E.164 recommendation.

phone_verified · boolean · デフォルト: false

Whether this phone number has been verified (true) or not (false).

created_at · string<date-time>

Date and time when this user was created.

updated_at · string<date-time>

Date and time when this user was last updated/modified.

identities · object[]

Array of user identity objects when accounts are linked.

Show child attributes

app_metadata · object

User metadata to which this user has read-only access.

user_metadata · object

User metadata to which this user has read/write access.

picture · string

URL to picture, photo, or avatar of this user.

name · string

Name of this user.

nickname · string

Preferred nickname or alias of this user.

multifactor · string[]

List of multi-factor authentication providers with which this user has enrolled.

multifactor_last_modified · string<date-time>

Last date and time this user's multi-factor authentication providers were updated.

last_ip · string

Last IP address from which this user logged in.

last_login · string<date-time>

Last date and time this user logged in.

last_password_reset · string<date-time>

Last date and time this user had their password reset.

logins_count · integer

Total number of logins this user has performed.

blocked · boolean

Whether this user was blocked by an administrator (true) or is not (false).

given_name · string

Given name/first name/forename of this user.

family_name · string

Family name/last name/surname of this user.