Class ResourceServersClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class ResourceServersClient : IResourceServersClient

Inheritance

object

ResourceServersClient

Implements

IResourceServersClient

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

Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs.

public WithRawResponseTask<CreateResourceServerResponseContent> CreateAsync(CreateResourceServerRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateResourceServerRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateResourceServerResponseContent>

Examples

await client.ResourceServers.CreateAsync(
    new CreateResourceServerRequestContent { Identifier = "identifier" }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete an existing API by ID. For more information, read API Settings.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

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

GetAsync(string, GetResourceServerRequestParameters, RequestOptions?, CancellationToken)

Retrieve API details with the given ID.

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

Parameters

id string

request GetResourceServerRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetResourceServerResponseContent>

Examples

await client.ResourceServers.GetAsync(
    "id",
    new GetResourceServerRequestParameters { IncludeFields = true }
);

ListAsync(ListResourceServerRequestParameters, RequestOptions?, CancellationToken)

Retrieve details of all APIs associated with your tenant.

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

Parameters

request ListResourceServerRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ResourceServer>>

Examples

await client.ResourceServers.ListAsync(
    new ListResourceServerRequestParameters
    {
        Identifiers = new List<string?>() { "identifiers" },
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
        IncludeFields = true,
    }
);

SearchAsync(SearchResourceServersRequestParameters, RequestOptions?, CancellationToken)

Search resource servers using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /resource-servers endpoint with better performance for complex queries. Results may not reflect recent updates immediately.

The signing_secret field is not supported by this endpoint.

public Task<Pager<ResourceServerSearchResponse>> SearchAsync(SearchResourceServersRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SearchResourceServersRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ResourceServerSearchResponse>>

Examples

await client.ResourceServers.SearchAsync(
    new SearchResourceServersRequestParameters
    {
        Q = "q",
        Parser = SearchParserEnum.Scim,
        Fields = "fields",
        IncludeFields = true,
        Take = 1,
        From = "from",
        Sort = ResourceServerSortFieldEnum.Identifier,
    }
);

UpdateAsync(string, UpdateResourceServerRequestContent, RequestOptions?, CancellationToken)

Change an existing API setting by resource server ID. For more information, read API Settings.

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

Parameters

id string

request UpdateResourceServerRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateResourceServerResponseContent>

Examples

await client.ResourceServers.UpdateAsync("id", new UpdateResourceServerRequestContent());