Get a user's roles

Retrieve detailed list of all user roles currently assigned to a user.

Note: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: Get user roles assigned to an Organization member.

Note: Returns only direct role assignments. To also include group-based role assignments, use GET /api/v2/users/{id}/effective-roles.

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

C#

C#

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

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.Roles.ListAsync(
            id: "id",
            request: new ListUserRolesRequestParameters {
                PerPage = 1,
                Page = 1,
                IncludeTotals = true
            }
        );
    }

}

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "owner_id": "<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 list roles for.

クエリパラメータ

per_page · integer

Number of results per page.

必須範囲: 1 <= x <= 100

page · integer

Page index of the results to return. First page is 0.

必須範囲: x >= 0

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

レスポンス

200

application/json

Roles successfully retrieved.

object[]

object

id · string

ID for this role.

name · string

Name of this role.

description · string

Description of this role.

type · enum<string> · EA

The type of the role

利用可能なオプション: tenant, organization

owner_id · string<organization-id> · EA

The id of the entity that owns this role, such as an organization id.

Maximum string length: 50