Associate permissions with a role

Add one or more permissions to a specified user role.

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

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.Permissions.AddAsync(
            id: "id",
            request: new AddRolePermissionsRequestContent {
                Permissions = new List<PermissionRequestPayload>(){
                    new PermissionRequestPayload {
                        ResourceServerIdentifier = "resource_server_identifier",
                        PermissionName = "permission_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"
    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.AddRolePermissionsRequestContent{
        Permissions: []*management.PermissionRequestPayload{
            &management.PermissionRequestPayload{
                ResourceServerIdentifier: "resource_server_identifier",
                PermissionName: "permission_name",
            },
        },
    }
    mgmt.Roles.Permissions.Add(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.roles.types.AddRolePermissionsRequestContent;
import com.auth0.client.mgmt.types.PermissionRequestPayload;
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().permissions().add(
            "id",
            AddRolePermissionsRequestContent
                .builder()
                .permissions(
                    Arrays.asList(
                        PermissionRequestPayload
                            .builder()
                            .resourceServerIdentifier("resource_server_identifier")
                            .permissionName("permission_name")
                            .build()
                    )
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Roles\Permissions\Requests\AddRolePermissionsRequestContent;
use Auth0\SDK\API\Management\Types\PermissionRequestPayload;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->roles->permissions->add(
    'id',
    new AddRolePermissionsRequestContent([
        'permissions' => [
            new PermissionRequestPayload([
                'resourceServerIdentifier' => 'resource_server_identifier',
                'permissionName' => 'permission_name',
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, PermissionRequestPayload

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

client.roles.permissions.add(
    id="id",
    permissions=[
        PermissionRequestPayload(
            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.roles.permissions.add(
  id: "id",
  permissions: [{
    resource_server_identifier: "resource_server_identifier",
    permission_name: "permission_name"
  }]
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.permissions.add("id", {
        permissions: [
            {
                resourceServerIdentifier: "resource_server_identifier",
                permissionName: "permission_name",
            },
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.roles.permissions.add("id", {
        permissions: [
            {
                resourceServerIdentifier: "resource_server_identifier",
                permissionName: "permission_name",
            },
        ],
    });
}
main();

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

Body

application/jsonapplication/x-www-form-urlencoded

permissions · object[] · required

array of resource_server_identifier, permission_name pairs.

Minimum array length: 1

Show child attributes

Response

201

Role permissions updated.