Assign roles to a user

Assign one or more existing user roles to a user. For more information, review Role-Based Access Control.

Note: New roles cannot be created through this action. Additionally, this action is used to assign roles to a user in the context of your whole tenant. To assign roles in the context of a specific Organization, use the following endpoint: Assign user roles to an Organization member.

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

C#

C#

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

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.AssignAsync(
            id: "id",
            request: new AssignUserRolesRequestContent {
                Roles = new List<string>(){
                    "roles",
                }

            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &users.AssignUserRolesRequestContent{
        Roles: []string{
            "roles",
        },
    }
    mgmt.Users.Roles.Assign(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.users.types.AssignUserRolesRequestContent;
import java.util.Arrays;

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

        client.users().roles().assign(
            "id",
            AssignUserRolesRequestContent
                .builder()
                .roles(
                    Arrays.asList("roles")
                )
                .build()
        );
    }
}

<?php

namespace Example;

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

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->roles->assign(
    'id',
    new AssignUserRolesRequestContent([
        'roles' => [
            'roles',
        ],
    ]),
);

from auth0.management import ManagementClient

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

client.users.roles.assign(
    id="id",
    roles=[
        "roles"
    ],
)

require "auth0"

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

client.users.roles.assign(
  id: "id",
  roles: ["roles"]
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.roles.assign("id", {
        roles: [
            "roles",
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.roles.assign("id", {
        roles: [
            "roles",
        ],
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/users/{id}/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roles": [
    "<string>"
  ]
}
'

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the user to associate roles with.

Body

application/jsonapplication/x-www-form-urlencoded

roles · string[] · required

List of roles IDs to associated with the user.

Minimum array length: 1

Minimum string length: 1

Response

204

Roles successfully associated with user.