Assign users to a role

Assign one or more users to an existing user role. To learn more, review Role-Based Access Control.

Note: New roles cannot be created through this action.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Roles;
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.Roles.Users.AssignAsync(
            id: "id",
            request: new AssignRoleUsersRequestContent {
                Users = new List<string>(){
                    "users",
                }

            }
        );
    }

}

package example

import (
    context "context"

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

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

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.roles.types.AssignRoleUsersRequestContent;
import java.util.Arrays;

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

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

<?php

namespace Example;

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

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

from auth0.management import ManagementClient

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

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

require "auth0"

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

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

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/roles/{id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    "<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 role to assign users to.

Body

application/jsonapplication/x-www-form-urlencoded

users · string<user-id-with-max-length>[] · required

user_id's of the users to assign the role to.

Response

200

Role users successfully updated.