Class PermissionsClient

Namespace

Auth0.ManagementApi.Roles

Assembly

Auth0.ManagementApi.dll

public class PermissionsClient : IPermissionsClient

Inheritance

object

PermissionsClient

Implements

IPermissionsClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

AddAsync(string, AddRolePermissionsRequestContent, RequestOptions?, CancellationToken)

Add one or more permissions to a specified user role.

public Task AddAsync(string id, AddRolePermissionsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request AddRolePermissionsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Roles.Permissions.AddAsync(
    "id",
    new AddRolePermissionsRequestContent
    {
        Permissions = new List<PermissionRequestPayload>()
        {
            new PermissionRequestPayload
            {
                ResourceServerIdentifier = "resource_server_identifier",
                PermissionName = "permission_name",
            },
        },
    }
);

DeleteAsync(string, DeleteRolePermissionsRequestContent, RequestOptions?, CancellationToken)

Remove one or more permissions from a specified user role.

public Task DeleteAsync(string id, DeleteRolePermissionsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request DeleteRolePermissionsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Roles.Permissions.DeleteAsync(
    "id",
    new DeleteRolePermissionsRequestContent
    {
        Permissions = new List<PermissionRequestPayload>()
        {
            new PermissionRequestPayload
            {
                ResourceServerIdentifier = "resource_server_identifier",
                PermissionName = "permission_name",
            },
        },
    }
);

ListAsync(string, ListRolePermissionsRequestParameters, RequestOptions?, CancellationToken)

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

public Task<Pager<PermissionsResponsePayload>> ListAsync(string id, ListRolePermissionsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListRolePermissionsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<PermissionsResponsePayload>>

Examples

await client.Roles.Permissions.ListAsync(
    "id",
    new ListRolePermissionsRequestParameters
    {
        PerPage = 1,
        Page = 1,
        IncludeTotals = true,
    }
);