Class RolesApi

Namespace

Cloudflare.NET.Roles

Assembly

Cloudflare.NET.dll

Implementation of IRolesApi for Cloudflare Account Roles.

Provides read-only access to predefined Cloudflare roles that define sets of permissions for account members.

public class RolesApi : ApiResource, IRolesApi

Inheritance

object

ApiResource

RolesApi

Implements

IRolesApi

Inherited Members

ApiResource.HttpClient

ApiResource.Logger

ApiResource.GetAsync<TResult>(string, CancellationToken)

ApiResource.GetAsync<TResult>(string, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.PostAsync<TResult>(string, object, CancellationToken)

ApiResource.PutAsync<TResult>(string, object, CancellationToken)

ApiResource.PutAsync<TResult>(string, object, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.PostAsync<TResult>(string, object, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.PostJsonAsync<TResult>(string, string, CancellationToken)

ApiResource.PutJsonAsync<TResult>(string, string, CancellationToken)

ApiResource.PutJsonAsync<TResult>(string, string, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.PatchAsync<TResult>(string, object, CancellationToken)

ApiResource.PatchAsync<TResult>(string, object, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.DeleteAsync<TResult>(string, CancellationToken)

ApiResource.DeleteAsync<TResult>(string, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.GetStringAsync(string, CancellationToken)

ApiResource.PostMultipartFileAsync<TResult>(string, Stream, string, string, CancellationToken)

ApiResource.GetPagePaginatedResultAsync<TItem>(string, CancellationToken)

ApiResource.GetCursorPaginatedResultAsync<TItem>(string, CancellationToken)

ApiResource.GetCursorPaginatedResultAsync<TWrapper, TItem>(string, Func<TWrapper, IReadOnlyList<TItem>>, CancellationToken)

ApiResource.GetCursorPaginatedResultAsync<TWrapper, TItem>(string, Func<TWrapper, IReadOnlyList<TItem>>, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.GetPaginatedAsync<TItem>(string, int?, CancellationToken)

ApiResource.GetCursorPaginatedAsync<TItem>(string, int?, CancellationToken)

ApiResource.GetCursorPaginatedAsync<TWrapper, TItem>(string, int?, Func<TWrapper, IReadOnlyList<TItem>>, CancellationToken)

ApiResource.GetCursorPaginatedAsync<TWrapper, TItem>(string, int?, Func<TWrapper, IReadOnlyList<TItem>>, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

ApiResource.ProcessResponse<T>(HttpResponseMessage, CancellationToken)

ApiResource.ProcessAndDeserializeAsync<T>(HttpResponseMessage, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RolesApi(HttpClient, ILoggerFactory)

Initializes a new instance of the RolesApi class.

public RolesApi(HttpClient httpClient, ILoggerFactory loggerFactory)

Parameters

httpClient HttpClient

The HttpClient for making requests.

loggerFactory ILoggerFactory

The factory to create loggers for this resource.

Methods

GetAccountRoleAsync(string, string, CancellationToken)

Gets details for a specific role.

public Task<AccountRole> GetAccountRoleAsync(string accountId, string roleId, CancellationToken cancellationToken = default)

Parameters

accountId string

The account identifier.

roleId string

The role identifier.

cancellationToken CancellationToken

A cancellation token.

Returns

Task<AccountRole>

The role details including permissions.

Examples

var role = await client.Roles.GetAccountRoleAsync(accountId, roleId);
Console.WriteLine($"Role: {role.Name}");
Console.WriteLine($"Description: {role.Description}");

// Check DNS permissions
if (role.Permissions.DnsRecords is { Read: true, Write: true })
  Console.WriteLine("Has full DNS access");

Exceptions

ArgumentNullException

Thrown when accountId or roleId is null.

ArgumentException

Thrown when accountId or roleId is empty or whitespace.

HttpRequestException

Thrown when the role is not found (HTTP 404).

ListAccountRolesAsync(string, ListAccountRolesFilters?, CancellationToken)

Lists all roles available in the account.

Roles are predefined by Cloudflare and define sets of permissions that can be assigned to account members.

public Task<PagePaginatedResult<AccountRole>> ListAccountRolesAsync(string accountId, ListAccountRolesFilters? filters = null, CancellationToken cancellationToken = default)

Parameters

accountId string

The account identifier.

filters ListAccountRolesFilters

Optional pagination options.

cancellationToken CancellationToken

A cancellation token.

Returns

Task<PagePaginatedResult<AccountRole>>

A page of account roles.

Examples

var roles = await client.Roles.ListAccountRolesAsync(accountId);

foreach (var role in roles.Items)
{
  Console.WriteLine($"{role.Name}: {role.Description}");
  if (role.Permissions.Dns?.Write == true)
    Console.WriteLine("  - Can modify DNS");
}

Exceptions

ArgumentNullException

Thrown when accountId is null.

ArgumentException

Thrown when accountId is empty or whitespace.

ListAllAccountRolesAsync(string, ListAccountRolesFilters?, CancellationToken)

Lists all roles available in the account, automatically handling pagination.

public IAsyncEnumerable<AccountRole> ListAllAccountRolesAsync(string accountId, ListAccountRolesFilters? filters = null, CancellationToken cancellationToken = default)

Parameters

accountId string

The account identifier.

filters ListAccountRolesFilters

Optional pagination options. Pagination parameters are ignored.

cancellationToken CancellationToken

A cancellation token.

Returns

IAsyncEnumerable<AccountRole>

An async enumerable of all account roles.

Examples

// Iterate through all roles without manual pagination
await foreach (var role in client.Roles.ListAllAccountRolesAsync(accountId))
{
  Console.WriteLine($"{role.Id}: {role.Name}");
}

Exceptions

ArgumentNullException

Thrown when accountId is null.

ArgumentException

Thrown when accountId is empty or whitespace.