Class UserAttributeProfilesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class UserAttributeProfilesClient : IUserAttributeProfilesClient

Inheritance

object

UserAttributeProfilesClient

Implements

IUserAttributeProfilesClient

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

Retrieve details about a single User Attribute Profile specified by ID.

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

Parameters

request CreateUserAttributeProfileRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateUserAttributeProfileResponseContent>

Examples

await client.UserAttributeProfiles.CreateAsync(
    new CreateUserAttributeProfileRequestContent
    {
        Name = "name",
        UserAttributes = new Dictionary<
            string,
            UserAttributeProfileUserAttributeAdditionalProperties
        >()
        {
            {
                "key",
                new UserAttributeProfileUserAttributeAdditionalProperties
                {
                    Description = "description",
                    Label = "label",
                    ProfileRequired = true,
                    Auth0Mapping = "auth0_mapping",
                }
            },
        },
    }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a single User Attribute Profile specified by ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

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

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single User Attribute Profile specified by ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetUserAttributeProfileResponseContent>

Examples

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

GetTemplateAsync(string, RequestOptions?, CancellationToken)

Retrieve a User Attribute Profile Template.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetUserAttributeProfileTemplateResponseContent>

Examples

await client.UserAttributeProfiles.GetTemplateAsync("id");

ListAsync(ListUserAttributeProfileRequestParameters, RequestOptions?, CancellationToken)

Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.

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

Parameters

request ListUserAttributeProfileRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<UserAttributeProfile>>

Examples

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

ListTemplatesAsync(RequestOptions?, CancellationToken)

Retrieve a list of User Attribute Profile Templates.

public WithRawResponseTask<ListUserAttributeProfileTemplateResponseContent> ListTemplatesAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<ListUserAttributeProfileTemplateResponseContent>

Examples

await client.UserAttributeProfiles.ListTemplatesAsync();

UpdateAsync(string, UpdateUserAttributeProfileRequestContent, RequestOptions?, CancellationToken)

Update the details of a specific User attribute profile, such as name, user_id and user_attributes.

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

Parameters

id string

request UpdateUserAttributeProfileRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateUserAttributeProfileResponseContent>

Examples

await client.UserAttributeProfiles.UpdateAsync(
    "id",
    new UpdateUserAttributeProfileRequestContent()
);