Class UserAttributeProfiles

Index

Constructors

constructor

new UserAttributeProfiles(
_options: UserAttributeProfiles.Options,
): UserAttributeProfiles
Parameters
- _options: UserAttributeProfiles.Options
Returns UserAttributeProfiles

Methods

list

list(
    request?: ListUserAttributeProfileRequestParameters,
    requestOptions?: UserAttributeProfiles.RequestOptions,
): Promise<
    Page<
        UserAttributeProfile,
        ListUserAttributeProfilesPaginatedResponseContent,
    >,
>
Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.
Parameters
- request: ListUserAttributeProfileRequestParameters = {}
- OptionalrequestOptions: UserAttributeProfiles.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
    })
```

create

create(
request: CreateUserAttributeProfileRequestContent,
requestOptions?: UserAttributeProfiles.RequestOptions,
): HttpResponsePromise<CreateUserAttributeProfileResponseContent>
Retrieve details about a single User Attribute Profile specified by ID.
Parameters
- request: CreateUserAttributeProfileRequestContent
- OptionalrequestOptions: UserAttributeProfiles.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"
            }
        }
    })
```

listTemplates

listTemplates(
requestOptions?: UserAttributeProfiles.RequestOptions,
): HttpResponsePromise<ListUserAttributeProfileTemplateResponseContent>
Retrieve a list of User Attribute Profile Templates.
Parameters
- OptionalrequestOptions: UserAttributeProfiles.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListUserAttributeProfileTemplateResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userAttributeProfiles.listTemplates()
```

getTemplate

getTemplate(
id: string,
requestOptions?: UserAttributeProfiles.RequestOptions,
): HttpResponsePromise<GetUserAttributeProfileTemplateResponseContent>
Retrieve a User Attribute Profile Template.
Parameters
- id: string
  ID of the user-attribute-profile-template to retrieve.
- OptionalrequestOptions: UserAttributeProfiles.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")
```

get

get(
id: string,
requestOptions?: UserAttributeProfiles.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: UserAttributeProfiles.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")
```

delete

delete(
id: string,
requestOptions?: UserAttributeProfiles.RequestOptions,
): HttpResponsePromise<void>
Delete a single User Attribute Profile specified by ID.
Parameters
- id: string
  ID of the user-attribute-profile to delete.
- OptionalrequestOptions: UserAttributeProfiles.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userAttributeProfiles.delete("id")
```

update

update(
    id: string,
    request?: UpdateUserAttributeProfileRequestContent,
    requestOptions?: UserAttributeProfiles.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: UserAttributeProfiles.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: UserAttributeProfiles.Options

Class UserAttributeProfiles

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns UserAttributeProfiles

Methods

list

Parameters

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

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateUserAttributeProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

listTemplates

Parameters

Returns HttpResponsePromise<ListUserAttributeProfileTemplateResponseContent>

Throws

Throws

Throws

Example

getTemplate

Parameters

Returns HttpResponsePromise<GetUserAttributeProfileTemplateResponseContent>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetUserAttributeProfileResponseContent>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateUserAttributeProfileResponseContent>

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

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

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options