public class OrganizationsEntity
extends java.lang.Object
This class is not thread-safe.
ManagementAPI
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
apiToken |
protected okhttp3.HttpUrl |
baseUrl |
protected okhttp3.OkHttpClient |
client |
Modifier and Type | Method and Description |
---|---|
Request<EnabledConnection> |
addConnection(java.lang.String orgId,
EnabledConnection connection)
Add a connection to an organization.
|
Request |
addMembers(java.lang.String orgId,
Members members)
Add members to an organization.
|
Request |
addRoles(java.lang.String orgId,
java.lang.String userId,
Roles roles)
Add roles for a member of an organization.
|
Request<Organization> |
create(Organization organization)
Create an organization.
|
Request<Invitation> |
createInvitation(java.lang.String orgId,
Invitation invitation)
Create an invitation.
|
Request |
delete(java.lang.String orgId)
Delete an organization.
|
Request |
deleteConnection(java.lang.String orgId,
java.lang.String connectionId)
Delete a connection from an organization.
|
Request |
deleteInvitation(java.lang.String orgId,
java.lang.String invitationId)
Delete an invitation.
|
Request |
deleteMembers(java.lang.String orgId,
Members members)
Delete members from an organization.
|
Request |
deleteRoles(java.lang.String orgId,
java.lang.String userId,
Roles roles)
Delete roles from a member of an organization.
|
Request<Organization> |
get(java.lang.String orgId)
Get an organization.
|
Request<Organization> |
getByName(java.lang.String orgName)
Get an organization.
|
Request<EnabledConnection> |
getConnection(java.lang.String orgId,
java.lang.String connectionId)
Get an organization's connection.
|
Request<EnabledConnectionsPage> |
getConnections(java.lang.String orgId,
PageFilter filter)
Get the connections of an organization.
|
Request<Invitation> |
getInvitation(java.lang.String orgId,
java.lang.String invitationId,
FieldsFilter filter)
Get an invitation.
|
Request<InvitationsPage> |
getInvitations(java.lang.String orgId,
InvitationsFilter filter)
Gets all invitations for an organization.
|
Request<MembersPage> |
getMembers(java.lang.String orgId,
PageFilter filter)
Get the members of an organization.
|
Request<RolesPage> |
getRoles(java.lang.String orgId,
java.lang.String userId,
PageFilter filter)
Get the roles for a member of an organization.
|
Request<OrganizationsPage> |
list(PageFilter filter)
Get all organizations.
|
Request<Organization> |
update(java.lang.String orgId,
Organization organization)
Update an organization.
|
Request<EnabledConnection> |
updateConnection(java.lang.String orgId,
java.lang.String connectionId,
EnabledConnection connection)
Update a connection of an organization.
|
protected final okhttp3.OkHttpClient client
protected final okhttp3.HttpUrl baseUrl
protected final java.lang.String apiToken
public Request<OrganizationsPage> list(PageFilter filter)
read:organizations
scope is required.filter
- an optional pagination filterpublic Request<Organization> get(java.lang.String orgId)
read:organizations
scope is required.orgId
- the ID of the organization to retrievepublic Request<Organization> getByName(java.lang.String orgName)
read:organizations
scope is required.orgName
- the name of the organization to retrievepublic Request<Organization> create(Organization organization)
create:organizations
scope is required.organization
- the organization to createpublic Request<Organization> update(java.lang.String orgId, Organization organization)
update:organizations
scope is required.orgId
- the ID of the organization to updateorganization
- the updated organizationpublic Request delete(java.lang.String orgId)
delete:organizations
scope is required.orgId
- the ID of the organization to deletepublic Request<MembersPage> getMembers(java.lang.String orgId, PageFilter filter)
read:organization_members
scope is required.orgId
- the ID of the organizationfilter
- an optional pagination filterpublic Request addMembers(java.lang.String orgId, Members members)
create:organization_members
scope is required.orgId
- the ID of the organizationmembers
- The members to addpublic Request deleteMembers(java.lang.String orgId, Members members)
delete:organization_members
scope is required.orgId
- the ID of the organizationmembers
- The members to removepublic Request<EnabledConnectionsPage> getConnections(java.lang.String orgId, PageFilter filter)
read:organization_connections
scope is required.orgId
- the ID of the organizationfilter
- an optional pagination filterpublic Request<EnabledConnection> getConnection(java.lang.String orgId, java.lang.String connectionId)
orgId
- the ID of the organizationconnectionId
- the ID of the connectionpublic Request<EnabledConnection> addConnection(java.lang.String orgId, EnabledConnection connection)
create:organization_connections
scope is required.orgId
- the ID of the organizationconnection
- The connection to addpublic Request deleteConnection(java.lang.String orgId, java.lang.String connectionId)
delete:organization_connections
scope is required.orgId
- the ID of the organizationconnectionId
- the ID of the connection to deletepublic Request<EnabledConnection> updateConnection(java.lang.String orgId, java.lang.String connectionId, EnabledConnection connection)
update:organization_connections
scope is required.orgId
- the ID of the organizationconnectionId
- the ID of the connection to updateconnection
- the connection to updatepublic Request<RolesPage> getRoles(java.lang.String orgId, java.lang.String userId, PageFilter filter)
read:organization_members
scope is required.orgId
- the ID of the organizationuserId
- the ID of the userfilter
- an optional pagination filterpublic Request addRoles(java.lang.String orgId, java.lang.String userId, Roles roles)
create:organization_member_roles
scope is required.orgId
- the ID of the organizationuserId
- the ID of the userroles
- the roles to addpublic Request deleteRoles(java.lang.String orgId, java.lang.String userId, Roles roles)
delete:organization_member_roles
scope is required.orgId
- the ID of the organizationuserId
- the ID of the userroles
- the roles to deletepublic Request<Invitation> createInvitation(java.lang.String orgId, Invitation invitation)
create:organization_invitations
scope is required.orgId
- the ID of the organizationinvitation
- the invitation to createpublic Request<Invitation> getInvitation(java.lang.String orgId, java.lang.String invitationId, FieldsFilter filter)
read:organization_invitations
scope is required.orgId
- the ID of the organizationinvitationId
- the ID of the invitationfilter
- an optional result filterpublic Request<InvitationsPage> getInvitations(java.lang.String orgId, InvitationsFilter filter)
read:organization_invitations
scope is required.orgId
- the ID of the organizationfilter
- an optional result filterpublic Request deleteInvitation(java.lang.String orgId, java.lang.String invitationId)
delete:organization_invitations`
scope is required.orgId
- the ID of the organizationinvitationId
- the ID of the invitation to delete