View Source Auth0.Management.UserAttributeProfiles (Auth0Api v2.5.0)

Facade for the Auth0 Management API User Attribute Profiles endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()

error()

id()

Functions

create(params, config)

Create a user attribute profile.

delete(id, config)

Delete a user attribute profile.

get(id, config)

Retrieve a user attribute profile by its ID.

get_template(id, config)

Get User Attribute Profile Template.

list(params, config)

Retrieve a list of user attribute profiles.

list_templates(config)

Get User Attribute Profile Templates.

update(id, params, config)

Update a user attribute profile.

Types

config()

@type config() :: Auth0.Config.t()

error()

@type error() :: {:error, integer(), term()} | {:error, term()}

id()

@type id() :: String.t()

Functions

create(params, config)

@spec create(map(), config()) :: {:ok, map()} | error()

Create a user attribute profile.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/post-user-attribute-profiles

delete(id, config)

@spec delete(id(), config()) :: {:ok, String.t()} | error()

Delete a user attribute profile.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/delete-user-attribute-profiles-by-id

get(id, config)

@spec get(id(), config()) :: {:ok, map()} | error()

Retrieve a user attribute profile by its ID.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profiles-by-id

get_template(id, config)

@spec get_template(String.t(), config()) :: {:ok, map()} | error()

Get User Attribute Profile Template.

Retrieve a User Attribute Profile Template.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profile-template

list(params, config)

@spec list(map(), config()) :: {:ok, [map()]} | error()

Retrieve a list of user attribute profiles.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profiles

list_templates(config)

@spec list_templates(config()) :: {:ok, map()} | error()

Get User Attribute Profile Templates.

Retrieve a list of User Attribute Profile Templates.

Early Access: this endpoint is marked as Early Access (x-release-lifecycle: EA) in the Auth0 Management API specification and may not be available on every tenant.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/get-user-attribute-profile-templates

update(id, params, config)

@spec update(id(), map(), config()) :: {:ok, map()} | error()

Update a user attribute profile.

see

https://auth0.com/docs/api/management/v2/user-attribute-profiles/patch-user-attribute-profiles-by-id