Package com.auth0.client.mgmt

Class OrganizationsEntity

java.lang.Object

com.auth0.client.mgmt.OrganizationsEntity

public class OrganizationsEntity
extends Object

Class that provides an implementation of the Organization endpoints of the Management API.

This class is not thread-safe.

See Also:

• ManagementAPI

Field Summary

Fields

Modifier and Type	Field	Description
protected final okhttp3.HttpUrl	baseUrl
protected final Auth0HttpClient	client
protected final TokenProvider	tokenProvider

Method Summary

Modifier and Type	Method	Description
Request<OrganizationClientGrant>	addClientGrant(String orgId, CreateOrganizationClientGrantRequestBody addOrganizationClientGrantRequestBody)	Associate a client grant with an organization.
Request<EnabledConnection>	addConnection(String orgId, EnabledConnection connection)	Add a connection to an organization.
Request<Void>	addMembers(String orgId, Members members)	Add members to an organization.
Request<Void>	addRoles(String orgId, String userId, Roles roles)	Add roles for a member of an organization.
Request<Organization>	create(Organization organization)	Create an organization.
Request<Invitation>	createInvitation(String orgId, Invitation invitation)	Create an invitation.
Request<Void>	delete(String orgId)	Delete an organization.
Request<Void>	deleteClientGrant(String orgId, String grantId)	Remove a client grant from an organization.
Request<Void>	deleteConnection(String orgId, String connectionId)	Delete a connection from an organization.
Request<Void>	deleteInvitation(String orgId, String invitationId)	Delete an invitation.
Request<Void>	deleteMembers(String orgId, Members members)	Delete members from an organization.
Request<Void>	deleteRoles(String orgId, String userId, Roles roles)	Delete roles from a member of an organization.
Request<Organization>	get(String orgId)	Get an organization.
Request<Organization>	getByName(String orgName)	Get an organization.
Request<EnabledConnection>	getConnection(String orgId, String connectionId)	Get an organization's connection.
Request<EnabledConnectionsPage>	getConnections(String orgId, PageFilter filter)	Get the connections of an organization.
Request<Invitation>	getInvitation(String orgId, String invitationId, FieldsFilter filter)	Get an invitation.
Request<InvitationsPage>	getInvitations(String orgId, InvitationsFilter filter)	Gets all invitations for an organization.
Request<MembersPage>	getMembers(String orgId, PageFilter filter)	Get the members of an organization.
Request<MembersPage>	getMembers(String orgId, PageFilter pageFilter, FieldsFilter fieldsFilter)	Get the members of an organization.
Request<RolesPage>	getRoles(String orgId, String userId, PageFilter filter)	Get the roles for a member of an organization.
Request<OrganizationsPage>	list(PageFilter filter)	Get all organizations.
Request<OrganizationClientGrantsPage>	listClientGrants(String orgId, OrganizationClientGrantsFilter filter)	Get the client grants associated with this organization.
protected <T> Request<T>	request(HttpMethod method, com.fasterxml.jackson.core.type.TypeReference<T> target, Consumer<com.auth0.client.mgmt.RequestBuilder<T>> customizer)
Request<Organization>	update(String orgId, Organization organization)	Update an organization.
Request<EnabledConnection>	updateConnection(String orgId, String connectionId, EnabledConnection connection)	Update a connection of an organization.
protected Request<Void>	voidRequest(HttpMethod method, Consumer<com.auth0.client.mgmt.RequestBuilder<Void>> customizer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

client

protected final Auth0HttpClient client

baseUrl

protected final okhttp3.HttpUrl baseUrl

tokenProvider

protected final TokenProvider tokenProvider

Method Details

list

public Request<OrganizationsPage> list(PageFilter filter)

Get all organizations. A token with read:organizations scope is required.

Parameters:

filter - an optional pagination filter

Returns:

a Request to execute

See Also:

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

get

public Request<Organization> get(String orgId)

Get an organization. A token with read:organizations scope is required.

Parameters:

orgId - the ID of the organization to retrieve

Returns:

a Request to execute

See Also:

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

getByName

public Request<Organization> getByName(String orgName)

Get an organization. A token with read:organizations scope is required.

Parameters:

orgName - the name of the organization to retrieve

Returns:

a Request to execute

See Also:

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

create

public Request<Organization> create(Organization organization)

Create an organization. A token with create:organizations scope is required.

Parameters:

organization - the organization to create

Returns:

a Request to execute

See Also:

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

update

public Request<Organization> update(String orgId,
 Organization organization)

Update an organization. A token with update:organizations scope is required.

Parameters:

orgId - the ID of the organization to update

organization - the updated organization

Returns:

a Request to execute

See Also:

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

delete

public Request<Void> delete(String orgId)

Delete an organization. A token with delete:organizations scope is required.

Parameters:

orgId - the ID of the organization to delete

Returns:

a Request to execute

See Also:

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

getMembers

public Request<MembersPage> getMembers(String orgId,
 PageFilter filter)

Get the members of an organization. A token with read:organization_members scope is required.

Parameters:

orgId - the ID of the organization

filter - an optional pagination filter

Returns:

a Request to execute

See Also:

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

getMembers

public Request<MembersPage> getMembers(String orgId,
 PageFilter pageFilter,
 FieldsFilter fieldsFilter)

Get the members of an organization. A token with read:organization_members scope is required.
Member roles are not sent by default. Supply a FieldsFilter that includes "roles" (and includeFields = true to retrieve the roles assigned to each listed member. To include the roles in the response, you must include the read:organization_member_roles scope in the token.

Parameters:

orgId - the ID of the organization

pageFilter - an optional pagination filter

fieldsFilter - an optional fields filter. If null, all fields (except roles) are returned.

Returns:

a Request to execute

See Also:

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

addMembers

public Request<Void> addMembers(String orgId,
 Members members)

Add members to an organization. A token with create:organization_members scope is required.

Parameters:

orgId - the ID of the organization

members - The members to add

Returns:

a Request to execute

See Also:

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

deleteMembers

public Request<Void> deleteMembers(String orgId,
 Members members)

Delete members from an organization. A token with delete:organization_members scope is required.

Parameters:

orgId - the ID of the organization

members - The members to remove

Returns:

a Request to execute

See Also:

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

getConnections

public Request<EnabledConnectionsPage> getConnections(String orgId,
 PageFilter filter)

Get the connections of an organization. A token with read:organization_connections scope is required.

Parameters:

orgId - the ID of the organization

filter - an optional pagination filter

Returns:

a Request to execute

See Also:

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

getConnection

public Request<EnabledConnection> getConnection(String orgId,
 String connectionId)

Get an organization's connection.

Parameters:

orgId - the ID of the organization

connectionId - the ID of the connection

Returns:

a Request to execute

See Also:

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

addConnection

public Request<EnabledConnection> addConnection(String orgId,
 EnabledConnection connection)

Add a connection to an organization. A token with create:organization_connections scope is required.

Parameters:

orgId - the ID of the organization

connection - The connection to add

Returns:

a Request to execute

See Also:

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

deleteConnection

public Request<Void> deleteConnection(String orgId,
 String connectionId)

Delete a connection from an organization. A token with delete:organization_connections scope is required.

Parameters:

orgId - the ID of the organization

connectionId - the ID of the connection to delete

Returns:

a Request to execute

See Also:

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

updateConnection

public Request<EnabledConnection> updateConnection(String orgId,
 String connectionId,
 EnabledConnection connection)

Update a connection of an organization. A token with update:organization_connections scope is required.

Parameters:

orgId - the ID of the organization

connectionId - the ID of the connection to update

connection - the connection to update

Returns:

a Request to execute

See Also:

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

getRoles

public Request<RolesPage> getRoles(String orgId,
 String userId,
 PageFilter filter)

Get the roles for a member of an organization. A token with read:organization_members scope is required.

Parameters:

orgId - the ID of the organization

userId - the ID of the user

filter - an optional pagination filter

Returns:

a Request to execute

See Also:

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

addRoles

public Request<Void> addRoles(String orgId,
 String userId,
 Roles roles)

Add roles for a member of an organization. A token with create:organization_member_roles scope is required.

Parameters:

orgId - the ID of the organization

userId - the ID of the user

roles - the roles to add

Returns:

a Request to execute

See Also:

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

deleteRoles

public Request<Void> deleteRoles(String orgId,
 String userId,
 Roles roles)

Delete roles from a member of an organization. A token with delete:organization_member_roles scope is required.

Parameters:

orgId - the ID of the organization

userId - the ID of the user

roles - the roles to delete

Returns:

a Request to execute

See Also:

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

createInvitation

public Request<Invitation> createInvitation(String orgId,
 Invitation invitation)

Create an invitation. A token with create:organization_invitations scope is required.

Parameters:

orgId - the ID of the organization

invitation - the invitation to create

Returns:

a Request to execute

See Also:

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

getInvitation

public Request<Invitation> getInvitation(String orgId,
 String invitationId,
 FieldsFilter filter)

Get an invitation. A token with read:organization_invitations scope is required.

Parameters:

orgId - the ID of the organization

invitationId - the ID of the invitation

filter - an optional result filter

Returns:

a Request to execute

See Also:

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

getInvitations

public Request<InvitationsPage> getInvitations(String orgId,
 InvitationsFilter filter)

Gets all invitations for an organization. A token with read:organization_invitations scope is required.

Parameters:

orgId - the ID of the organization

filter - an optional result filter

Returns:

a Request to execute

See Also:

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

deleteInvitation

public Request<Void> deleteInvitation(String orgId,
 String invitationId)

Delete an invitation. A token with delete:organization_invitations` scope is required.

Parameters:

orgId - the ID of the organization

invitationId - the ID of the invitation to delete

Returns:

a Request to execute

See Also:

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

listClientGrants

public Request<OrganizationClientGrantsPage> listClientGrants(String orgId,
 OrganizationClientGrantsFilter filter)

Get the client grants associated with this organization. A token with scope read:organization_client_grants is required.

Parameters:

orgId - the organization ID.

filter - an optional filter to refine results.

Returns:

a request to execute.

addClientGrant

public Request<OrganizationClientGrant> addClientGrant(String orgId,
 CreateOrganizationClientGrantRequestBody addOrganizationClientGrantRequestBody)

Associate a client grant with an organization. A token with scope create:organization_client_grants is required.

Parameters:

orgId - the organization ID.

addOrganizationClientGrantRequestBody - the body of the request containing information about the client grant to associate.

Returns:

a request to execute.

deleteClientGrant

public Request<Void> deleteClientGrant(String orgId,
 String grantId)

Remove a client grant from an organization. A token with scope delete:organization_client_grants is required.

Parameters:

orgId - the organization ID.

grantId - the client grant ID.

Returns:

a request to execute.

voidRequest

protected Request<Void> voidRequest(HttpMethod method,
 Consumer<com.auth0.client.mgmt.RequestBuilder<Void>> customizer)

request

protected <T> Request<T> request(HttpMethod method,
 com.fasterxml.jackson.core.type.TypeReference<T> target,
 Consumer<com.auth0.client.mgmt.RequestBuilder<T>> customizer)