Class AgentsClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class AgentsClient : IAgentsClient

Inheritance

object

AgentsClient

Implements

IAgentsClient

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

Create an agent

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

Parameters

request CreateAgentRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<AgentResponseContent>

Examples

await client.Agents.CreateAsync(new CreateAgentRequestContent { Name = "name" });

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete an agent

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

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

ListAsync(ListAgentsRequestParameters, RequestOptions?, CancellationToken)

Get agents

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

Parameters

request ListAgentsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<AgentResponseContent>>

Examples

await client.Agents.ListAsync(new ListAgentsRequestParameters { From = "from", Take = 1 });

ReadAsync(string, RequestOptions?, CancellationToken)

Get an agent

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<AgentResponseContent>

Examples

await client.Agents.ReadAsync("id");

UpdateAsync(string, PatchAgentRequestParameters, RequestOptions?, CancellationToken)

Update an agent

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

Parameters

id string

request PatchAgentRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<AgentResponseContent>

Examples

await client.Agents.UpdateAsync("id", new PatchAgentRequestParameters());