List the roles which grant the user a given permission (whether directly or through groups).

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

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.EffectivePermissions.Sources.Roles.ListAsync(
            id: "id",
            request: new ListUserEffectivePermissionRoleSourceRequestParameters {
                From = "from",
                Take = 1,
                ResourceServerIdentifier = "resource_server_identifier",
                PermissionName = "permission_name"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.users.effectivepermissions.sources.types.ListUserEffectivePermissionRoleSourceRequestParameters;

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

        client.users().effectivePermissions().sources().roles().list(
            "id",
            ListUserEffectivePermissionRoleSourceRequestParameters
                .builder()
                .resourceServerIdentifier("resource_server_identifier")
                .permissionName("permission_name")
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\EffectivePermissions\Sources\Roles\Requests\ListUserEffectivePermissionRoleSourceRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->effectivePermissions->sources->roles->list(
    'id',
    new ListUserEffectivePermissionRoleSourceRequestParameters([
        'from' => 'from',
        'take' => 1,
        'resourceServerIdentifier' => 'resource_server_identifier',
        'permissionName' => 'permission_name',
    ]),
);

from auth0.management import ManagementClient

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

client.users.effective_permissions.sources.roles.list(
    id="id",
    from="from",
    take=1,
    resource_server_identifier="resource_server_identifier",
    permission_name="permission_name",
)

require "auth0"

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

client.users.effective_permissions.sources.roles.list(
  id: "id",
  from: "from",
  take: 1,
  resource_server_identifier: "resource_server_identifier",
  permission_name: "permission_name"
)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/users/{id}/effective-permissions/sources/effective-roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/users/{id}/effective-permissions/sources/effective-roles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "owner_id": "<string>",
      "sources": []
    }
  ],
  "next": "<string>"
}

GET

https://{tenantDomain}/api/v2

users

{id}

effective-permissions

sources

effective-roles

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

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.EffectivePermissions.Sources.Roles.ListAsync(
            id: "id",
            request: new ListUserEffectivePermissionRoleSourceRequestParameters {
                From = "from",
                Take = 1,
                ResourceServerIdentifier = "resource_server_identifier",
                PermissionName = "permission_name"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.users.effectivepermissions.sources.types.ListUserEffectivePermissionRoleSourceRequestParameters;

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

        client.users().effectivePermissions().sources().roles().list(
            "id",
            ListUserEffectivePermissionRoleSourceRequestParameters
                .builder()
                .resourceServerIdentifier("resource_server_identifier")
                .permissionName("permission_name")
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\EffectivePermissions\Sources\Roles\Requests\ListUserEffectivePermissionRoleSourceRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->effectivePermissions->sources->roles->list(
    'id',
    new ListUserEffectivePermissionRoleSourceRequestParameters([
        'from' => 'from',
        'take' => 1,
        'resourceServerIdentifier' => 'resource_server_identifier',
        'permissionName' => 'permission_name',
    ]),
);

from auth0.management import ManagementClient

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

client.users.effective_permissions.sources.roles.list(
    id="id",
    from="from",
    take=1,
    resource_server_identifier="resource_server_identifier",
    permission_name="permission_name",
)

require "auth0"

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

client.users.effective_permissions.sources.roles.list(
  id: "id",
  from: "from",
  take: 1,
  resource_server_identifier: "resource_server_identifier",
  permission_name: "permission_name"
)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/users/{id}/effective-permissions/sources/effective-roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/users/{id}/effective-permissions/sources/effective-roles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "owner_id": "<string>",
      "sources": []
    }
  ],
  "next": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

ID of the user to retrieve the permissions for.

Query Parameters

from

string

Optional Id from which to start selection.

take

integer

Number of results per page. Defaults to 50.

Required range: x >= 1

resource_server_identifier

string

required

The identifier of the resource server for which to calculate user permissions.

Required string length: 1 - 600

permission_name

string

required

Name of this permission

Required string length: 1 - 280

Response

User's effective permission role sources successfully retrieved.

roles

object[]

required

Roles with the specified permission assigned to the user, both directly and via groups.

Show child attributes

string

A cursor to be used as the "from" query parameter for the next page of results.

List the permissions assigned to a user directly or through roles or groups.

List the roles for a user with sources: directly assigned or through group membership.

⌘I