Class BaseClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Base class from which all Client classes inherit.

public abstract class BaseClient

Inheritance

object

BaseClient

Derived

ActionsClient

AttackProtectionClient

BlacklistedTokensClient

BrandingClient

ClientGrantsClient

ClientsClient

ConnectionsClient

CustomDomainsClient

DeviceCredentialsClient

EmailProviderClient

EmailTemplatesClient

GrantsClient

GuardianClient

HooksClient

JobsClient

KeysClient

LogStreamsClient

LogsClient

OrganizationsClient

PromptsClient

ResourceServersClient

RolesClient

RulesClient

RulesConfigClient

StatsClient

TenantSettingsClient

TicketsClient

UserBlocksClient

UsersClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BaseClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of BaseClient.

protected BaseClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Properties

BaseUri

Uri of the endpoint to use in making API calls.

protected Uri BaseUri { get; }

Property Value

Uri

Connection

IManagementConnection used to make all API calls.

protected IManagementConnection Connection { get; }

Property Value

IManagementConnection

DefaultHeaders

Default headers included with every request this client makes.

protected IDictionary<string, string> DefaultHeaders { get; }

Property Value

IDictionary<string, string>

Methods

BuildUri(string, IDictionary<string, string>)

Build the Uri for this API request given a resource and queryStrings.

protected Uri BuildUri(string resource, IDictionary<string, string> queryStrings = null)

Parameters

resource string

Name of the resource to be appended to the path.

queryStrings IDictionary<string, string>

Query strings that should be combined with the URL.

Returns

Uri

Completed absolute URI for the request.

EncodePath(string)

Encode a value so it can be successfully used in the path.

protected string EncodePath(string value)

Parameters

value string

Value to encode for the path.

Returns

string

URI encoded/escaped value that can be used in the path.