Table of Contents

Class ClientGrantsClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public class ClientGrantsClient : IClientGrantsClient
Inheritance
ClientGrantsClient
Implements
Inherited Members
Extension Methods

Properties

Organizations 

public IOrganizationsClient Organizations { get; }

Property Value

IOrganizationsClient

Methods

CreateAsync(CreateClientGrantRequestContent, RequestOptions?, CancellationToken)

Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.

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

Parameters

request CreateClientGrantRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateClientGrantResponseContent>

Examples

await client.ClientGrants.CreateAsync(
    new CreateClientGrantRequestContent { Audience = "audience" }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete the Client Credential Flow from your machine-to-machine application.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

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

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve a single client grant, including the scopes associated with the application/API pair.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetClientGrantResponseContent>

Examples

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

ListAsync(ListClientGrantsRequestParameters, RequestOptions?, CancellationToken)

Retrieve a list of client grants, including the scopes associated with the application/API pair.

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

Parameters

request ListClientGrantsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<ClientGrantResponseContent>>

Examples

await client.ClientGrants.ListAsync(
    new ListClientGrantsRequestParameters
    {
        IncludeTotals = true,
        From = "from",
        Take = 1,
        Audience = "audience",
        ClientId = "client_id",
        AllowAnyOrganization = true,
        SubjectType = ClientGrantSubjectTypeEnum.Client,
        DefaultFor = ClientGrantDefaultForEnum.ThirdPartyClients,
    }
);

SearchAsync(SearchClientGrantsRequestParameters, RequestOptions?, CancellationToken)

Search client grants 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 /client-grants endpoint with better performance for complex queries. Results may not reflect recent updates immediately.

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

Parameters

request SearchClientGrantsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<ClientGrantResponseContent>>

Examples

await client.ClientGrants.SearchAsync(
    new SearchClientGrantsRequestParameters
    {
        Q = "q",
        Parser = SearchParserEnum.Scim,
        Fields = "fields",
        IncludeFields = true,
        Take = 1,
        From = "from",
        Sort = ClientGrantSortFieldEnum.Audience,
    }
);

UpdateAsync(string, UpdateClientGrantRequestContent, RequestOptions?, CancellationToken)

Update a client grant.

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

Parameters

id string
request UpdateClientGrantRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateClientGrantResponseContent>

Examples

await client.ClientGrants.UpdateAsync("id", new UpdateClientGrantRequestContent());