Auth0.Management.Roles (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Roles.

endpoint

/api/v2/roles
/api/v2/roles/{id}
/api/v2/roles/{id}/permissions
/api/v2/roles/{id}/users

Link to this section Summary

Types

config()

error()

id()

response_body()

Functions

assign_users(id, params, config)

Assign users to a role.

associate_permissions(id, params, config)

Associate permissions with a role.

create(params, config)

Create a role.

delete(id, config)

Delete a role.

get(id, config)

Get a role.

list(params, config)

Get roles.

list_permissions(id, params, config)

Get permissions granted by role.

list_users(id, params, config)

Get a role's users.

remove_permissions(id, params, config)

Remove permissions from a role.

update(id, params, config)

Update a role.

Link to this section Types

config()

Specs

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

error()

Specs

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

id()

Specs

id() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

assign_users(id, params, config)

Specs

assign_users(
  id(),
  Auth0.Management.Roles.Users.Assign.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Assign users to a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/post_role_users

associate_permissions(id, params, config)

Specs

associate_permissions(
  id(),
  Auth0.Management.Roles.Permissions.Associate.Params.t() | map(),
  config()
) :: {:ok, String.t(), response_body()} | error()

Associate permissions with a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/post_role_permission_assignment

create(params, config)

Specs

create(Auth0.Management.Roles.Create.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Role.t(), response_body()} | error()

Create a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/post_roles

delete(id, config)

Specs

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

Delete a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/delete_roles_by_id

get(id, config)

Specs

get(id(), config()) :: {:ok, Auth0.Entity.Role.t(), response_body()} | error()

Get a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_roles_by_id

list(params, config)

Specs

list(Auth0.Management.Roles.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Roles.t(), response_body()} | error()

Get roles.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_roles

list_permissions(id, params, config)

Specs

list_permissions(
  id(),
  Auth0.Management.Roles.Permissions.List.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Permissions.t(), response_body()} | error()

Get permissions granted by role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_role_permission

list_users(id, params, config)

Specs

list_users(id(), Auth0.Management.Roles.Users.List.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Users.t(), response_body()} | error()

Get a role's users.

see

https://auth0.com/docs/api/management/v2/#!/Roles/get_role_user

remove_permissions(id, params, config)

Specs

remove_permissions(
  id(),
  Auth0.Management.Roles.Permissions.Remove.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Remove permissions from a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/delete_role_permission_assignment

update(id, params, config)

Specs

update(id(), Auth0.Management.Roles.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Role.t(), response_body()} | error()

Update a role.

see

https://auth0.com/docs/api/management/v2/#!/Roles/patch_roles_by_id