• management
• SDK
• UserAttributeProfilesClient

Class UserAttributeProfilesClient

Index

Constructors

constructor

Methods

listcreatelistTemplatesgetTemplategetdeleteupdate

Properties

_options

Constructors

constructor

new UserAttributeProfilesClient(
options: BaseClientOptions,
): UserAttributeProfilesClient

Parameters

• options: BaseClientOptions

Returns UserAttributeProfilesClient

Methods

list

list(
request?: ListUserAttributeProfileRequestParameters,
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): Promise<
Page<
UserAttributeProfile,
ListUserAttributeProfilesPaginatedResponseContent,
>,
>

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

Parameters

• request: ListUserAttributeProfileRequestParameters = {}
• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< UserAttributeProfile, ListUserAttributeProfilesPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.list({ from: "from", take: 1 })Copy

create

create(
request: CreateUserAttributeProfileRequestContent,
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): HttpResponsePromise<CreateUserAttributeProfileResponseContent>

Create a User Attribute Profile

Parameters

• request: CreateUserAttributeProfileRequestContent
• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateUserAttributeProfileResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.create({ name: "name", user_attributes: { "key": { description: "description", label: "label", profile_required: true, auth0_mapping: "auth0_mapping" } } })Copy

listTemplates

listTemplates(
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): HttpResponsePromise<ListUserAttributeProfileTemplateResponseContent>

Retrieve a list of User Attribute Profile Templates.

Parameters

• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<ListUserAttributeProfileTemplateResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.listTemplates()Copy

getTemplate

getTemplate(
id: string,
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): HttpResponsePromise<GetUserAttributeProfileTemplateResponseContent>

Retrieve a User Attribute Profile Template.

Parameters

• id: string

ID of the user-attribute-profile-template to retrieve.

• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetUserAttributeProfileTemplateResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.getTemplate("id")Copy

get

get(
id: string,
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): HttpResponsePromise<GetUserAttributeProfileResponseContent>

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

Parameters

• id: string

ID of the user-attribute-profile to retrieve.

• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetUserAttributeProfileResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.get("id")Copy

delete

delete(
id: string,
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): HttpResponsePromise<void>

Delete a single User Attribute Profile specified by ID.

Parameters

• id: string

ID of the user-attribute-profile to delete.

• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.delete("id")Copy

update

update(
id: string,
request?: UpdateUserAttributeProfileRequestContent,
requestOptions?: UserAttributeProfilesClient.RequestOptions,
): HttpResponsePromise<UpdateUserAttributeProfileResponseContent>

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

Parameters

• id: string

ID of the user attribute profile to update.

• request: UpdateUserAttributeProfileRequestContent = {}
• OptionalrequestOptions: UserAttributeProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateUserAttributeProfileResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.userAttributeProfiles.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreatelistTemplatesgetTemplategetdeleteupdate Properties _options