Auth0Api v1.4.0

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

Documentation for Auth0 Management API of Organizations.

endpoint

  • /api/v2/organizations
  • /api/v2/organizations/{id}
  • /api/v2/organizations/name/{name}
  • /api/v2/organizations/{id}/enabled_connections
  • /api/v2/organizations/{id}/enabled_connections/{connectionId}
  • /api/v2/organizations/{id}/invitations
  • /api/v2/organizations/{id}/invitations/{invitation_id}
  • /api/v2/organizations/{id}/members

Link to this section Summary

Types

config()
connection_id()
error()
id()
invitation_id()
name()
response_body()
user_id()

Functions

add_connection(id, params, config)

Add connections to an organization.

add_members(id, params, config)

Add members to an organization.

assign_roles(id, user_id, params, config)

Add members to an organization.

create(params, config)

Create an Organization.

create_invitation(id, params, config)

Create invitations to organization.

delete(id, config)

Delete organization.

delete_connection(id, connection_id, config)

Delete connections from an organization.

delete_invitation(id, invitation_id, config)

Delete an invitation to organization.

delete_members(id, params, config)

Delete members from an organization.

delete_roles(id, user_id, params, config)

Delete members from an organization.

get(id, config)

Get organization.

get_by_name(name, config)

Get organization by name.

get_connection(id, connection_id, config)

Get an enabled connection for an organization.

get_invitation(id, invitation_id, params, config)

Get an invitation to organization.

list(params, config)

Get organizations.

list_connections(id, params, config)

Get connections enabled for an organization.

list_invitations(id, params, config)

Get invitations to organization.

list_members(id, params, config)

Get members who belong to an organization.

list_roles(id, user_id, params, config)

Get the roles assigned to an organization member.

modify(id, params, config)

Modify an Organization.

modify_connection(id, connection_id, params, config)

Modify an Organizations Connection.

Link to this section Types

Link to this type

config()

View Source

Specs

config() :: Auth0.Config.t()
Link to this type

connection_id()

View Source

Specs

connection_id() :: String.t()
Link to this type

error()

View Source

Specs

error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

id()

View Source

Specs

id() :: String.t()
Link to this type

invitation_id()

View Source

Specs

invitation_id() :: String.t()
Link to this type

name()

View Source

Specs

name() :: String.t()
Link to this type

response_body()

View Source

Specs

response_body() :: String.t()
Link to this type

user_id()

View Source

Specs

user_id() :: String.t()

Link to this section Functions

Link to this function

add_connection(id, params, config)

View Source

Specs

add_connection(
  id(),
  Auth0.Management.Organizations.EnabledConnections.Create.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.EnabledConnection.t(), response_body()} | error()

Add connections to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_enabled_connections

Link to this function

add_members(id, params, config)

View Source

Specs

add_members(
  id(),
  Auth0.Management.Organizations.Members.Add.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Add members to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_members

Link to this function

assign_roles(id, user_id, params, config)

View Source

Specs

assign_roles(
  id(),
  user_id(),
  Auth0.Management.Organizations.Members.Roles.Add.Params.t() | map(),
  config()
) :: {:ok, String.t(), response_body()} | error()

Add members to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_members

Link to this function

create(params, config)

View Source

Specs

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

Create an Organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_organizations

Link to this function

create_invitation(id, params, config)

View Source

Specs

create_invitation(
  id(),
  Auth0.Management.Organizations.Invitations.Create.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.Invitation.t(), response_body()} | error()

Create invitations to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/post_invitations

Link to this function

delete(id, config)

View Source

Specs

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

Delete organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_organizations_by_id

Link to this function

delete_connection(id, connection_id, config)

View Source

Specs

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

Delete connections from an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_enabled_connections_by_connectionId

Link to this function

delete_invitation(id, invitation_id, config)

View Source

Specs

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

Delete an invitation to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_invitations_by_invitation_id

Link to this function

delete_members(id, params, config)

View Source

Specs

delete_members(
  id(),
  Auth0.Management.Organizations.Members.Delete.Params.t() | map(),
  config()
) ::
  {:ok, String.t(), response_body()} | error()

Delete members from an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_members

Link to this function

delete_roles(id, user_id, params, config)

View Source

Specs

delete_roles(
  id(),
  user_id(),
  Auth0.Management.Organizations.Members.Roles.Delete.Params.t() | map(),
  config()
) :: {:ok, String.t(), response_body()} | error()

Delete members from an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/delete_members

Link to this function

get(id, config)

View Source

Specs

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

Get organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations_by_id

Link to this function

get_by_name(name, config)

View Source

Specs

get_by_name(name(), config()) ::
  {:ok, Auth0.Entity.Organization.t(), response_body()} | error()

Get organization by name.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_name_by_name

Link to this function

get_connection(id, connection_id, config)

View Source

Specs

get_connection(id(), connection_id(), config()) ::
  {:ok, Auth0.Entity.EnabledConnection.t(), response_body()} | error()

Get an enabled connection for an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections_by_connectionId

Link to this function

get_invitation(id, invitation_id, params, config)

View Source

Specs

get_invitation(
  id(),
  invitation_id(),
  Auth0.Management.Organizations.Invitations.Get.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.Invitation.t(), response_body()} | error()

Get an invitation to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations_by_invitation_id

Link to this function

list(params, config)

View Source

Specs

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

Get organizations.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_organizations

Link to this function

list_connections(id, params, config)

View Source

Specs

list_connections(
  id(),
  Auth0.Management.Organizations.EnabledConnections.List.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.EnabledConnections.t(), response_body()} | error()

Get connections enabled for an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_enabled_connections

Link to this function

list_invitations(id, params, config)

View Source

Specs

list_invitations(
  id(),
  Auth0.Management.Organizations.Invitations.List.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.Invitations.t(), response_body()} | error()

Get invitations to organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_invitations

Link to this function

list_members(id, params, config)

View Source

Specs

list_members(
  id(),
  Auth0.Management.Organizations.Members.List.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.Members.t(), response_body()} | error()

Get members who belong to an organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_members

Link to this function

list_roles(id, user_id, params, config)

View Source

Specs

list_roles(
  id(),
  user_id(),
  Auth0.Management.Organizations.Members.Roles.List.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.Roles.t(), response_body()} | error()

Get the roles assigned to an organization member.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/get_organization_member_roles

Link to this function

modify(id, params, config)

View Source

Specs

modify(id(), Auth0.Management.Organizations.Patch.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.Organization.t(), response_body()} | error()

Modify an Organization.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/patch_organizations_by_id

Link to this function

modify_connection(id, connection_id, params, config)

View Source

Specs

modify_connection(
  id(),
  connection_id(),
  Auth0.Management.Organizations.EnabledConnections.Patch.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.EnabledConnection.t(), response_body()} | error()

Modify an Organizations Connection.

see

https://auth0.com/docs/api/management/v2/#!/Organizations/patch_enabled_connections_by_connectionId