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

Facade for the Auth0 Management API Roles endpoints.

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

Summary

Types

config()

error()

id()

Functions

assign_groups(id, params, config)

Assign groups to a role.

assign_users(id, params, config)

Assign one or more users to an existing user role.

associate_permissions(id, params, config)

Add one or more permissions to a specified user role.

create(params, config)

Create a user role for Role-Based Access Control.

delete(id, config)

Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.

get(id, config)

Retrieve details about a specific user role specified by ID.

list(params, config)

Retrieve detailed list of user roles created in your tenant.

list_groups(id, params, config)

Get a role's groups.

list_permissions(id, params, config)

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

list_users(id, params, config)

Retrieve list of users associated with a specific role.

remove_groups(id, params, config)

Remove groups from a role.

remove_permissions(id, params, config)

Remove one or more permissions from a specified user role.

update(id, params, config)

Modify the details of a specific user role specified by ID.

Types

config()

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

error()

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

id()

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

Functions

assign_groups(id, params, config)

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

Assign groups to a role.

Assign one or more groups to a specified role.

see

https://auth0.com/docs/api/management/v2/roles/post-role-groups

assign_users(id, params, config)

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

Assign one or more users to an existing user role.

see

https://auth0.com/docs/api/management/v2/roles/post-role-users

associate_permissions(id, params, config)

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

Add one or more permissions to a specified user role.

see

https://auth0.com/docs/api/management/v2/roles/post-role-permission-assignment

create(params, config)

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

Create a user role for Role-Based Access Control.

see

https://auth0.com/docs/api/management/v2/roles/post-roles

delete(id, config)

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

Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.

see

https://auth0.com/docs/api/management/v2/roles/delete-roles-by-id

get(id, config)

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

Retrieve details about a specific user role specified by ID.

see

https://auth0.com/docs/api/management/v2/roles/get-roles-by-id

list(params, config)

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

Retrieve detailed list of user roles created in your tenant.

see

https://auth0.com/docs/api/management/v2/roles/get-roles

list_groups(id, params, config)

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

Get a role's groups.

Lists the groups to which the specified role is assigned.

see

https://auth0.com/docs/api/management/v2/roles/get-role-groups

list_permissions(id, params, config)

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

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

see

https://auth0.com/docs/api/management/v2/roles/get-role-permission

list_users(id, params, config)

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

Retrieve list of users associated with a specific role.

see

https://auth0.com/docs/api/management/v2/roles/get-role-user

remove_groups(id, params, config)

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

Remove groups from a role.

Unassign one or more groups from a specified role.

see

https://auth0.com/docs/api/management/v2/roles/delete-role-groups

remove_permissions(id, params, config)

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

Remove one or more permissions from a specified user role.

see

https://auth0.com/docs/api/management/v2/roles/delete-role-permission-assignment

update(id, params, config)

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

Modify the details of a specific user role specified by ID.

see

https://auth0.com/docs/api/management/v2/roles/patch-roles-by-id