Class RefreshTokensClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class RefreshTokensClient : IRefreshTokensClient

Inheritance

object

RefreshTokensClient

Implements

IRefreshTokensClient

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

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a refresh token by its ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.RefreshTokens.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve refresh token information.

public WithRawResponseTask<GetRefreshTokenResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetRefreshTokenResponseContent>

Examples

await client.RefreshTokens.GetAsync("id");

ListAsync(GetRefreshTokensRequestParameters, RequestOptions?, CancellationToken)

Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.

public Task<Pager<RefreshTokenResponseContent>> ListAsync(GetRefreshTokensRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request GetRefreshTokensRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<RefreshTokenResponseContent>>

Examples

await client.RefreshTokens.ListAsync(
    new GetRefreshTokensRequestParameters
    {
        UserId = "user_id",
        ClientId = "client_id",
        From = "from",
        Take = 1,
        Fields = "fields",
        IncludeFields = true,
    }
);

RevokeAsync(RevokeRefreshTokensRequestContent, RequestOptions?, CancellationToken)

Revoke refresh tokens in bulk by ID list, user, user+client, or client.

public Task RevokeAsync(RevokeRefreshTokensRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request RevokeRefreshTokensRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.RefreshTokens.RevokeAsync(new RevokeRefreshTokensRequestContent());

UpdateAsync(string, UpdateRefreshTokenRequestContent, RequestOptions?, CancellationToken)

Update a refresh token by its ID.

public WithRawResponseTask<UpdateRefreshTokenResponseContent> UpdateAsync(string id, UpdateRefreshTokenRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateRefreshTokenRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateRefreshTokenResponseContent>

Examples

await client.RefreshTokens.UpdateAsync("id", new UpdateRefreshTokenRequestContent());