Create a role

Create a user role for Role-Based Access Control.

Note: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.

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

C#

C#

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

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.CreateAsync(
            new CreateRoleRequestContent {
                Name = "name"
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateRoleRequestContent{
        Name: "name",
    }
    mgmt.Roles.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateRoleRequestContent;

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

        client.roles().create(
            CreateRoleRequestContent
                .builder()
                .name("name")
                .build()
        );
    }
}

<?php

namespace Example;

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

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->roles->create(
    new CreateRoleRequestContent([
        'name' => 'name',
    ]),
);

from auth0.management import ManagementClient

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

client.roles.create(
    name="name",
)

require "auth0"

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

client.roles.create(name: "name")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.create({
        name: "name",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.create({
        name: "name",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "owner_id": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "owner_id": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

name · string · requis

Name of the role.

description · string

Description of the role.

type · enum<string> · EA

The type of the role. Defaults to tenant.

Options disponibles: tenant, organization

owner_id · string<organization-id> · EA

The ID of the organization that owns this role. Required when type is "organization".

Maximum string length: 50

Réponse

200

application/json

Role successfully created.

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

Options disponibles: 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