Class CredentialsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public class CredentialsClient : ICredentialsClient

Inheritance

object

CredentialsClient

Implements

ICredentialsClient

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

public WithRawResponseTask<PostClientCredentialResponseContent> CreateAsync(string clientId, PostClientCredentialRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

clientId string

request PostClientCredentialRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<PostClientCredentialResponseContent>

DeleteAsync(string, string, RequestOptions?, CancellationToken)

Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.

public Task DeleteAsync(string clientId, string credentialId, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

clientId string

credentialId string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Clients.Credentials.DeleteAsync("client_id", "credential_id");

GetAsync(string, string, RequestOptions?, CancellationToken)

Get the details of a client credential.

Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.

public WithRawResponseTask<GetClientCredentialResponseContent> GetAsync(string clientId, string credentialId, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

clientId string

credentialId string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetClientCredentialResponseContent>

Examples

await client.Clients.Credentials.GetAsync("client_id", "credential_id");

ListAsync(string, RequestOptions?, CancellationToken)

Get the details of a client credential.

Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.

public WithRawResponseTask<IEnumerable<ClientCredential>> ListAsync(string clientId, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

clientId string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<IEnumerable<ClientCredential>>

Examples

await client.Clients.Credentials.ListAsync("client_id");

UpdateAsync(string, string, PatchClientCredentialRequestContent, RequestOptions?, CancellationToken)

Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.

public WithRawResponseTask<PatchClientCredentialResponseContent> UpdateAsync(string clientId, string credentialId, PatchClientCredentialRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

clientId string

credentialId string

request PatchClientCredentialRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<PatchClientCredentialResponseContent>

Examples

await client.Clients.Credentials.UpdateAsync(
    "client_id",
    "credential_id",
    new PatchClientCredentialRequestContent()
);