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

Facade for the Auth0 Management API Groups.

Summary

Types

config()

error()

Functions

assign_roles(id, params, config)

Assign roles to a group.

delete(id, config)

Delete a Group.

get(id, config)

Get a Group.

list(params, config)

Get all Groups.

list_members(id, params, config)

Get Group Members.

list_roles(id, params, config)

Get a group's roles.

remove_roles(id, params, config)

Remove roles from a group.

Types

config()

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

error()

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

Functions

assign_roles(id, params, config)

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

Assign roles to a group.

Assign one or more roles to a specified group.

see

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

delete(id, config)

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

Delete a Group.

Delete a group by its ID.

see

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

get(id, config)

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

Get a Group.

Retrieve a group by its ID.

see

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

list(params, config)

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

Get all Groups.

List all groups in your tenant.

see

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

list_members(id, params, config)

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

Get Group Members.

List all users that are a member of this group.

see

https://auth0.com/docs/api/management/v2/groups/get-group-members

list_roles(id, params, config)

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

Get a group's roles.

Lists the roles assigned to a group.

see

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

remove_roles(id, params, config)

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

Remove roles from a group.

Unassign one or more roles from a specified group.

see

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