Table of Contents

Class ClientProfilesClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public class ClientProfilesClient : IClientProfilesClient
Inheritance
ClientProfilesClient
Implements
Inherited Members
Extension Methods

Methods

CreateAsync(CreateClientProfileRequestContent, RequestOptions?, CancellationToken)

Create a client profile. At most one profile is allowed per tenant in this release; attempting to create a second returns 409 Conflict. The profile governs Dynamic CIMD clients matched by its apply_policy at runtime.

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

Parameters

request CreateClientProfileRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<ClientProfile>

Examples

await client.ClientProfiles.CreateAsync(
    new CreateClientProfileRequestContent
    {
        Name = "name",
        ClientConfiguration = new ClientProfileClientConfiguration(),
        ApplyPolicy = new ClientProfileApplyPolicy
        {
            ExternalMetadataType = ClientProfileApplyPolicyExternalMetadataTypeEnum.Cimd,
            ExternalMetadataCreatedBy =
                ClientProfileApplyPolicyExternalMetadataCreatedByEnum.Client,
        },
    }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a client profile. Idempotent: returns 204 No Content whether or not a profile with the given ID existed. Deleting the profile removes fleet governance for matched clients immediately.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

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

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve a single client profile by its identifier. Returns 404 if no profile with the given ID exists for the tenant.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<ClientProfile>

Examples

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

ListAsync(ListClientProfilesRequestParameters, RequestOptions?, CancellationToken)

Retrieve a paginated list of client profiles for the tenant. Uses checkpoint pagination: pass the next cursor from a previous response as the from query parameter to retrieve the following page.

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

Parameters

request ListClientProfilesRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<ClientProfile>>

Examples

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

UpdateAsync(string, UpdateClientProfileRequestContent, RequestOptions?, CancellationToken)

Update a client profile. Supports partial updates at the top level (JSON Merge Patch); omitted top-level fields remain unchanged. Nested objects such as client_configuration must be supplied in full.

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

Parameters

id string
request UpdateClientProfileRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<ClientProfile>

Examples

await client.ClientProfiles.UpdateAsync("id", new UpdateClientProfileRequestContent());