View Source Auth0.Management.Organizations (Auth0Api v2.2.0)

Summary

Types

config()

connection_id()

error()

id()

invitation_id()

name()

user_id()

Functions

add_connection(id, params, config)

Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.

add_members(id, params, config)

Set one or more existing users as members of a specific Organization.

assign_roles(id, user_id, params, config)

Assign one or more roles to a user to determine their access for a specific Organization.

create(params, config)

Create a new Organization within your tenant.

create_invitation(id, params, config)

Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization.

delete(id, config)

Remove an Organization from your tenant. This action cannot be undone.

delete_connection(id, connection_id, config)

Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.

delete_invitation(id, invitation_id, config)

Delete an invitation to an Organization

delete_members(id, params, config)

Delete members from an organization

delete_roles(id, user_id, params, config)

Remove one or more Organization-specific roles from a given user.

get(id, config)

Retrieve details about a single Organization specified by ID.

get_by_name(name, config)

Retrieve details about a single Organization specified by name.

get_connection(id, connection_id, config)

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

get_invitation(id, invitation_id, params, config)

Get a specific invitation to an Organization

list(params, config)

Retrive detailed list of all Organizations available in your tenant.

list_connections(id, params, config)

list_invitations(id, params, config)

Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration.

list_members(id, params, config)

List organization members.

list_roles(id, user_id, params, config)

Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.

modify(id, params, config)

Update the details of a specific Organization, such as name and display name, branding options, and metadata.

modify_connection(id, connection_id, params, config)

Modify the details of a specific connection currently enabled for an Organization.

Types

config()

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

connection_id()

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

error()

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

id()

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

invitation_id()

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

name()

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

user_id()

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

Functions

add_connection(id, params, config)

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

Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.

see

https://auth0.com/docs/api/management/v2/organizations/post-enabled-connections

add_members(id, params, config)

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

Set one or more existing users as members of a specific Organization.

see

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

assign_roles(id, user_id, params, config)

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

Assign one or more roles to a user to determine their access for a specific Organization.

see

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

create(params, config)

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

Create a new Organization within your tenant.

see

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

create_invitation(id, params, config)

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

Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization.

see

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

delete(id, config)

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

Remove an Organization from your tenant. This action cannot be undone.

see

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

delete_connection(id, connection_id, config)

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

Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.

see

https://auth0.com/docs/api/management/v2/organizations/delete-enabled-connections-by-connection-id

delete_invitation(id, invitation_id, config)

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

Delete an invitation to an Organization

see

https://auth0.com/docs/api/management/v2/organizations/delete-invitations-by-invitation-id

delete_members(id, params, config)

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

Delete members from an organization

see

https://auth0.com/docs/api/management/v2/organizations/delete-members

delete_roles(id, user_id, params, config)

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

Remove one or more Organization-specific roles from a given user.

see

https://auth0.com/docs/api/management/v2/organizations/delete-organization-member-roles

get(id, config)

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

Retrieve details about a single Organization specified by ID.

see

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

get_by_name(name, config)

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

Retrieve details about a single Organization specified by name.

see

https://auth0.com/docs/api/management/v2/organizations/get-name-by-name

get_connection(id, connection_id, config)

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

see

https://auth0.com/docs/api/management/v2/organizations/get-enabled-connections-by-connection-id

get_invitation(id, invitation_id, params, config)

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

Get a specific invitation to an Organization

see

https://auth0.com/docs/api/management/v2/organizations/get-invitations-by-invitation-id

list(params, config)

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

Retrive detailed list of all Organizations available in your tenant.

see

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

list_connections(id, params, config)

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

see

https://auth0.com/docs/api/management/v2/organizations/get-enabled-connections

list_invitations(id, params, config)

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

see

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

list_members(id, params, config)

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

List organization members.

see

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

list_roles(id, user_id, params, config)

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

Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.

see

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

modify(id, params, config)

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

Update the details of a specific Organization, such as name and display name, branding options, and metadata.

see

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

modify_connection(id, connection_id, params, config)

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

Modify the details of a specific connection currently enabled for an Organization.

see

https://auth0.com/docs/api/management/v2/organizations/patch-enabled-connections-by-connection-id