com.iland.core.web.rest.api

Interface O365OrganizationResource

@Path(value="/o365-organizations")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface O365OrganizationResource

Office 365 VBO Organizations Resource.

Author:

Julien Anguenot

Method Summary

Modifier and Type	Method and Description
void	cancelPurgeMailboxes(String uuid, Set<O365MailboxPurgeRequest> request) Cancels the purge request for the given mailboxes of the given organization.
O365JobResponse	createO365Job(String uuid, O365JobRequest request) Create a new Office 365 VBO backup job.
InputStream	exportUsers(String uuid) Download the entire users as CSV for the Office 365 Organization.
O365GroupPaginatedSetResponse	getGroups(String uuid, Integer page, Integer pageSize) Get the groups for the Office 365 Organization.
O365DeviceCodeResponse	getO365DeviceCode(String uuid) Get a device code response from Microsoft Azure to validate in the Microsoft authentication portal.
O365OrganizationResponse	getOrganization(String uuid) Get an Office 365 VBO Organization given its UUID.
O365JobSetResponse	getOrganizationJobs(String uuid) Get Office 365 VBO Organization Jobs given an Organization's UUID.
O365RestoreSessionSetResponse	getOrganizationRestoreSessionsActive(String uuid) Get Office 365 VBO organization's active restore sessions given an organization's UUID.
O365RestoreSessionPaginatedSetResponse	getOrganizationRestoreSessionsHistory(String uuid, Integer page, Integer pageSize) Get Office 365 VBO Organization's inactive restore sessions given an Organization's UUID.
O365PurgedUserSetResponse	getPurgeMailboxes(String uuid) Given an org uuid, get all the mailboxes marked for purge (any status).
O365SharePointSiteSetResponse	getSharepointSites(String uuid, Integer page, Integer pageSize) Get Office 365 VBO Sharepoint sites given an organization UUID.
O365TeamSetResponse	getTeams(String uuid, Integer page, Integer pageSize) Get Office 365 VBO Teams given an organization UUID.
O365UserPaginatedSetResponse	getUsers(String uuid, Integer page, Integer pageSize, String searchUser) Get the users for the Office 365 Organization.
O365BackupRepositorySetResponse	getVboBackupRepositories(String uuid) Get Office 365 VBO backup repositories based on the company and location of the given organization uuid
void	markMailboxesForPurge(String uuid, Set<O365MailboxPurgeRequest> request) Submits a purge request for the given mailboxes of the given organization.
void	modifyOrganizationCredentials(String uuid, O365OrganizationCreateModifyRequest request) Modify the credentials and online settings of a Microsoft Office 365 VBO organization given its uuid.
void	removeOrganization(String uuid) Remove a Microsoft Office 365 VBO organization given its uuid.
O365RestoreSessionResponse	startRestoreSession(String uuid, O365RestoreSessionStartRequest request) Starts restore sessions for exploring and performing restore operations with backups.

Method Detail

getOrganization

@GET
 @Path(value="/{uuid}")
O365OrganizationResponse getOrganization(@PathParam(value="uuid")
                                                                      String uuid)

Get an Office 365 VBO Organization given its UUID.

Parameters:

uuid - The Office 365 VBO Organization UUID

Returns:

a O365OrganizationResponse instance

getOrganizationJobs

@GET
 @Path(value="/{uuid}/jobs")
O365JobSetResponse getOrganizationJobs(@PathParam(value="uuid")
                                                                         String uuid)

Get Office 365 VBO Organization Jobs given an Organization's UUID.

Parameters:

uuid - The Office 365 VBO Organization UUID

Returns:

a O365JobSetResponse instance

getOrganizationRestoreSessionsHistory

@GET
 @Path(value="/{uuid}/inactive-restore-sessions")
O365RestoreSessionPaginatedSetResponse getOrganizationRestoreSessionsHistory(@PathParam(value="uuid")
                                                                                                                                    String uuid,
                                                                                                                                    @QueryParam(value="page")
                                                                                                                                    Integer page,
                                                                                                                                    @QueryParam(value="pageSize")
                                                                                                                                    Integer pageSize)

Get Office 365 VBO Organization's inactive restore sessions given an Organization's UUID.

Parameters:

uuid - The Office 365 VBO Organization UUID

page - the page number

pageSize - the page size

Returns:

a O365RestoreSessionPaginatedSetResponse instance

getOrganizationRestoreSessionsActive

@GET
 @Path(value="/{uuid}/active-restore-sessions")
O365RestoreSessionSetResponse getOrganizationRestoreSessionsActive(@PathParam(value="uuid")
                                                                                                                        String uuid)

Get Office 365 VBO organization's active restore sessions given an organization's UUID.

Parameters:

uuid - The Office 365 VBO Organization UUID

Returns:

a O365RestoreSessionSetResponse instance

startRestoreSession

@POST
 @Path(value="/{uuid}/actions/start-restore-session")
 @Consumes(value="application/json")
O365RestoreSessionResponse startRestoreSession(@PathParam(value="uuid")
                                                                                                                                                String uuid,
                                                                                                                                                O365RestoreSessionStartRequest request)

Starts restore sessions for exploring and performing restore operations with backups.

Parameters:

uuid - The Office 365 VBO Organization UUID

request - a O365RestoreSessionStartRequest

Returns:

a O365RestoreSessionResponse instance

removeOrganization

@DELETE
 @Path(value="/{uuid}")
 @Consumes(value="application/json")
void removeOrganization(@PathParam(value="uuid")
                                                                                             String uuid)

Remove a Microsoft Office 365 VBO organization given its uuid.

Parameters:

uuid - The Office 365 VBO Organization UUID.

getUsers

@GET
 @Path(value="/{uuid}/users")
 @Consumes(value="application/json")
O365UserPaginatedSetResponse getUsers(@PathParam(value="uuid")
                                                                                                              String uuid,
                                                                                                              @QueryParam(value="page")
                                                                                                              Integer page,
                                                                                                              @QueryParam(value="pageSize")
                                                                                                              Integer pageSize,
                                                                                                              @QueryParam(value="searchUser")
                                                                                                              String searchUser)

Get the users for the Office 365 Organization.

Parameters:

uuid - The Office 365 VBO Organization UUID

page - the page number

pageSize - the page size

searchUser - the user's name or display name to search on

Returns:

a O365UserPaginatedSetResponse instance

exportUsers

@POST
 @Path(value="/{uuid}/users-export")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream exportUsers(@PathParam(value="uuid")
                                                                                                                                                                             String uuid)

Download the entire users as CSV for the Office 365 Organization.

Parameters:

uuid - The Office 365 VBO Organization UUID

Returns:

a InputStream representing the users file.

getGroups

@GET
 @Path(value="/{uuid}/groups")
 @Consumes(value="application/json")
O365GroupPaginatedSetResponse getGroups(@PathParam(value="uuid")
                                                                                                                 String uuid,
                                                                                                                 @QueryParam(value="page")
                                                                                                                 Integer page,
                                                                                                                 @QueryParam(value="pageSize")
                                                                                                                 Integer pageSize)

Get the groups for the Office 365 Organization.

Parameters:

uuid - The Office 365 VBO Organization UUID

page - the page number

pageSize - the page size

Returns:

a O365GroupPaginatedSetResponse instance

getVboBackupRepositories

@GET
 @Path(value="/{uuid}/backup-repositories")
 @Consumes(value="application/json")
O365BackupRepositorySetResponse getVboBackupRepositories(@PathParam(value="uuid")
                                                                                                                                               String uuid)

Get Office 365 VBO backup repositories based on the company and location of the given organization uuid

Parameters:

uuid - The Office 365 VBO Organization UUID

Returns:

the O365BackupRepositorySetResponse

createO365Job

@POST
 @Path(value="/{uuid}/actions/create-job")
 @Consumes(value="application/json")
O365JobResponse createO365Job(@PathParam(value="uuid")
                                                                                                                    String uuid,
                                                                                                                    O365JobRequest request)

Create a new Office 365 VBO backup job.

Parameters:

uuid - The Office 365 VBO Organization UUID

request - a O365JobRequest

Returns:

a O365JobResponse instance

getSharepointSites

@GET
 @Path(value="/{uuid}/sharepoint-sites")
O365SharePointSiteSetResponse getSharepointSites(@PathParam(value="uuid")
                                                                                               String uuid,
                                                                                               @QueryParam(value="page")
                                                                                               Integer page,
                                                                                               @QueryParam(value="pageSize")
                                                                                               Integer pageSize)

Get Office 365 VBO Sharepoint sites given an organization UUID.

Parameters:

uuid - The Office 365 VBO organization UUID.

page - the page number

pageSize - the page size

Returns:

a O365SharePointSiteSetResponse instance

getTeams

@GET
 @Path(value="/{uuid}/teams")
O365TeamSetResponse getTeams(@PathParam(value="uuid")
                                                                String uuid,
                                                                @QueryParam(value="page")
                                                                Integer page,
                                                                @QueryParam(value="pageSize")
                                                                Integer pageSize)

Get Office 365 VBO Teams given an organization UUID.

Parameters:

uuid - The Office 365 VBO organization UUID.

page - the page number

pageSize - the page size

Returns:

a O365TeamSetResponse instance

modifyOrganizationCredentials

@POST
 @Path(value="/{uuid}/actions/modify")
 @Consumes(value="application/json")
void modifyOrganizationCredentials(@PathParam(value="uuid")
                                                                                                                     String uuid,
                                                                                                                     O365OrganizationCreateModifyRequest request)

Modify the credentials and online settings of a Microsoft Office 365 VBO organization given its uuid. Please note that the credentials have to be changed in MS Azure AD account first before updating here.

Parameters:

uuid - The Office 365 VBO Organization UUID.

request - The Office 365 VBO Organization modify request.

markMailboxesForPurge

@POST
 @Path(value="/{uuid}/actions/purge-mailboxes")
 @Consumes(value="application/json")
void markMailboxesForPurge(@PathParam(value="uuid")
                                                                                                                      String uuid,
                                                                                                                      Set<O365MailboxPurgeRequest> request)

Submits a purge request for the given mailboxes of the given organization. Please note that mailboxes sent in this request will not be actually deleted until the grace period (in days) as defined in the config has elapsed.

Parameters:

uuid - The Office 365 VBO Organization UUID.

request - the set of purge mailboxes requested

getPurgeMailboxes

@GET
 @Path(value="/{uuid}/actions/get-purge-mailboxes")
 @Consumes(value="application/json")
O365PurgedUserSetResponse getPurgeMailboxes(@PathParam(value="uuid")
                                                                                                                                          String uuid)

Given an org uuid, get all the mailboxes marked for purge (any status).

Parameters:

uuid - The Office 365 VBO Organization UUID.

Returns:

the set of mailboxes marked for purge (any status).

cancelPurgeMailboxes

@POST
 @Path(value="/{uuid}/actions/cancel-purge")
 @Consumes(value="application/json")
void cancelPurgeMailboxes(@PathParam(value="uuid")
                                                                                                                  String uuid,
                                                                                                                  Set<O365MailboxPurgeRequest> request)

Cancels the purge request for the given mailboxes of the given organization.

Parameters:

uuid - The Office 365 VBO Organization UUID.

request - the set of purge mailboxes to cancel

getO365DeviceCode

@GET
 @Path(value="/{uuid}/actions/get-o365-device-code")
 @Consumes(value="application/json")
O365DeviceCodeResponse getO365DeviceCode(@PathParam(value="uuid")
                                                                                                                                        String uuid)

Get a device code response from Microsoft Azure to validate in the Microsoft authentication portal. This is to be used while modifying an org.

Returns:

a O365DeviceCodeResponse instance