Class RolesClient

Namespace

Auth0.ManagementApi.Organizations.Groups

Assembly

Auth0.ManagementApi.dll

public class RolesClient : IRolesClient

Inheritance

object

RolesClient

Implements

IRolesClient

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, string, CreateOrganizationGroupRolesRequestContent, RequestOptions?, CancellationToken)

Assign one or more roles to a specified group in the context of an organization.

public Task CreateAsync(string organizationId, string groupId, CreateOrganizationGroupRolesRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

groupId string

request CreateOrganizationGroupRolesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Groups.Roles.CreateAsync(
    "organization_id",
    "group_id",
    new CreateOrganizationGroupRolesRequestContent { Roles = new List<string>() { "roles" } }
);

DeleteAsync(string, string, DeleteOrganizationGroupRolesRequestContent, RequestOptions?, CancellationToken)

Unassign one or more roles from a specified group in the context of an organization.

public Task DeleteAsync(string organizationId, string groupId, DeleteOrganizationGroupRolesRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

groupId string

request DeleteOrganizationGroupRolesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Groups.Roles.DeleteAsync(
    "organization_id",
    "group_id",
    new DeleteOrganizationGroupRolesRequestContent { Roles = new List<string>() { "roles" } }
);

ListAsync(string, string, ListOrganizationGroupRolesRequestParameters, RequestOptions?, CancellationToken)

Lists the roles assigned to the specified group in the context of an organization.

public Task<Pager<Role>> ListAsync(string organizationId, string groupId, ListOrganizationGroupRolesRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

groupId string

request ListOrganizationGroupRolesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Role>>

Examples

await client.Organizations.Groups.Roles.ListAsync(
    "organization_id",
    "group_id",
    new ListOrganizationGroupRolesRequestParameters { From = "from", Take = 1 }
);