List member roles - Auth0 Docs

TypeScript

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.members.roles.list("user_id", {
        from: "from",
        take: 1,
    });
}
main();

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.members.roles.list("user_id", {
        from: "from",
        take: 1,
    });
}
main();

package example

import (
    context "context"

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

func do() {
    c, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &myorganization.ListOrgMemberRolesRequestParameters{
        From: myorganization.String(
            "from",
        ),
        Take: myorganization.Int(
            1,
        ),
    }
    c.Organization.Members.Roles.List(
        context.TODO(),
        "user_id",
        request,
    )
}

using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization.Members;

public partial class Examples
{
    public async Task Example() {
        var client = new MyOrganizationClient(new MyOrganizationClientOptions
        {
            Domain = "{YOUR_DOMAIN}",
            TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
        });

        await client.Organization.Members.Roles.ListAsync(
            userId: "user_id",
            request: new ListOrgMemberRolesRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.members.types.ListOrgMemberRolesRequestParameters;

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

        client.organization().members().roles().list(
            "user_id",
            ListOrgMemberRolesRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

from auth0.myorganization import MyOrganizationClient

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

client.organization.members.roles.list(
    user_id="user_id",
    from_="from",
    take=1,
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/members/{user_id}/roles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/members/{user_id}/roles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "roles": [
    {
      "id": "rol_SO2j0sFo9NFa3F9w",
      "name": "role1",
      "description": "role1 description"
    },
    {
      "id": "rol_BO2j1sFo9NFa3F9w",
      "name": "role2",
      "description": "role2 description"
    }
  ]
}

{
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "status": 400,
  "title": "Validation Error",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "type": "https://auth0.com/api-errors#A0E-401-0002",
  "status": 401,
  "title": "Missing Token",
  "detail": "No auth token provided."
}

{
  "type": "https://auth0.com/api-errors#A0E-403-0002",
  "status": 403,
  "title": "Insufficient Scope",
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint."
}

{
  "type": "https://auth0.com/api-errors#A0E-404-0002",
  "status": 404,
  "title": "Resource Not Found",
  "detail": "The organization does not exist."
}

{
  "type": "https://auth0.com/api-errors#A0E-429-0003",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "detail": "The endpoint request limit has been exceeded."
}

GET

members

{user_id}

roles

TypeScript

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.members.roles.list("user_id", {
        from: "from",
        take: 1,
    });
}
main();

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.members.roles.list("user_id", {
        from: "from",
        take: 1,
    });
}
main();

package example

import (
    context "context"

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

func do() {
    c, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &myorganization.ListOrgMemberRolesRequestParameters{
        From: myorganization.String(
            "from",
        ),
        Take: myorganization.Int(
            1,
        ),
    }
    c.Organization.Members.Roles.List(
        context.TODO(),
        "user_id",
        request,
    )
}

using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization.Members;

public partial class Examples
{
    public async Task Example() {
        var client = new MyOrganizationClient(new MyOrganizationClientOptions
        {
            Domain = "{YOUR_DOMAIN}",
            TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
        });

        await client.Organization.Members.Roles.ListAsync(
            userId: "user_id",
            request: new ListOrgMemberRolesRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.members.types.ListOrgMemberRolesRequestParameters;

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

        client.organization().members().roles().list(
            "user_id",
            ListOrgMemberRolesRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

from auth0.myorganization import MyOrganizationClient

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

client.organization.members.roles.list(
    user_id="user_id",
    from_="from",
    take=1,
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/members/{user_id}/roles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/members/{user_id}/roles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "roles": [
    {
      "id": "rol_SO2j0sFo9NFa3F9w",
      "name": "role1",
      "description": "role1 description"
    },
    {
      "id": "rol_BO2j1sFo9NFa3F9w",
      "name": "role2",
      "description": "role2 description"
    }
  ]
}

{
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "status": 400,
  "title": "Validation Error",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "type": "https://auth0.com/api-errors#A0E-401-0002",
  "status": 401,
  "title": "Missing Token",
  "detail": "No auth token provided."
}

{
  "type": "https://auth0.com/api-errors#A0E-403-0002",
  "status": 403,
  "title": "Insufficient Scope",
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint."
}

{
  "type": "https://auth0.com/api-errors#A0E-404-0002",
  "status": 404,
  "title": "Resource Not Found",
  "detail": "The organization does not exist."
}

{
  "type": "https://auth0.com/api-errors#A0E-429-0003",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "detail": "The endpoint request limit has been exceeded."
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

user_id

string

required

The user ID.

Pattern: ^(?=.{1,1024}$).+\|.+$

Query Parameters

from

string

An optional cursor from which to start the selection (exclusive).

Required string length: 1 - 1000

take

integer

default:50

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

Response

Retrieved memeber roles successfully.

roles

object[]

required

Show child attributes

string

Pagination cursor for the next page of results