Class PermissionsClient

Namespace

Auth0.ManagementApi.Users

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

CreateAsync(string, CreateUserPermissionsRequestContent, RequestOptions?, CancellationToken)

Assign permissions to a user.

public WithRawResponseTask CreateAsync(string id, CreateUserPermissionsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request CreateUserPermissionsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

await client.Users.Permissions.CreateAsync(
    "id",
    new CreateUserPermissionsRequestContent
    {
        Permissions = new List<PermissionRequestPayload>()
        {
            new PermissionRequestPayload
            {
                ResourceServerIdentifier = "resource_server_identifier",
                PermissionName = "permission_name",
            },
        },
    }
);

DeleteAsync(string, DeleteUserPermissionsRequestContent, RequestOptions?, CancellationToken)

Remove permissions from a user.

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

Parameters

id string

request DeleteUserPermissionsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

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

ListAsync(string, ListUserPermissionsRequestParameters, RequestOptions?, CancellationToken)

Retrieve all permissions associated with the user.

Note: Returns only permissions from direct assignments and directly assigned roles. For permissions a user has via group-based role assignments, use GET /api/v2/users/{id}/effective-permissions.

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

Parameters

id string

request ListUserPermissionsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<UserPermissionSchema>>

Examples

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