@Path(value="/users")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface UserResource
| Modifier and Type | Method and Description |
|---|---|
void |
delete(String username)
Deletes a user.
|
void |
deleteCompanyRole(String username,
String companyId)
Deletes a user's role within a specified company.
|
void |
endAllActiveSessions(String username)
Ends all active sessions for the user.
|
void |
endSession(String username,
String sessionId)
Ends a session for a user.
|
AccountEventListResponse |
getAccountEvents(String username,
Integer offset,
Integer limit,
Long dateFrom,
Long dateTo)
Gets account event logs.
|
UserSessionListResponse |
getActiveSessions(String username)
Gets a user's current sessions.
|
OrgListResponse |
getAllUserOrgs(String username)
Gets the list of orgs that the user has access to.
|
BackupGroupListResponse |
getBackupGroupsForUser(String username,
String companyId,
String locationId,
boolean includeSummaryStats,
boolean includeLastRun,
boolean includeBackupPolicy)
Get the backup groups for a company and user.
|
BaCompanySetResponse |
getBaCompaniesForUser(String username,
String companyId,
String locationId)
Get the vac companies for company and user.
|
CatalogListResponse |
getCatalogsForUser(String username,
String companyId,
String locationId)
Get the catalogs for the given company and user.
|
CompanyListResponse |
getCompanies(String username)
Gets the list of companies that the user has access to.
|
RoleResponse |
getCompanyRole(String username,
String companyId)
Get the company role for a specified user.
|
EdgeListResponse |
getEdgesForUser(String username,
String companyId,
String locationId)
Get the edges for a company and user.
|
UserEntityHistorySubscriptionListResponse |
getEntityHistorySubscriptions(String username)
Get entity history subscriptions for a given user.
|
UserInventoryResponse |
getInventory(String username,
String companyId)
Gets the inventory hierarchy for a user.
|
LoginEventListResponse |
getLoginEvents(String username,
Integer offset,
Integer limit)
Get login events for a user.
|
MediaListResponse |
getMediaForUser(String username,
String companyId,
String locationId)
Get the media for a company and user.
|
O365RestoreSessionSetResponse |
getO365ActiveRestoreSessionsForUser(String username,
String companyId,
String locationId)
Get the Office 365 VBO active restore sessions for a company and user.
|
O365JobSetResponse |
getO365JobsForUser(String username,
String companyId,
String locationId)
Get the Office 365 VBO jobs for a company and user.
|
O365OrganizationSetResponse |
getO365OrganizationsForUser(String username,
String companyId,
String locationId)
Get the Office 365 VBO companies for a company and user.
|
OrgListResponse |
getOrgsForUser(String username,
String companyId,
String locationId)
Get the orgs for a company and user.
|
OrgVdcNetworkListResponse |
getOrgVdcNetworksForUser(String username,
String companyId,
String locationId)
Get the org vdc networks for the company and user.
|
UserPreferencesResponse |
getPreferences(String username)
Retrieve user preferences section.
|
UserResponse |
getUser(String username)
Returns the user specified by their username.
|
UserAlertEmailsResponse |
getUserAlertEmails(String username)
Get the set of user alerting emails for a given username.
|
VappNetworkListResponse |
getVappNetworksForUser(String username,
String companyId,
String locationId)
Get the vapp networks for the company and user.
|
VappListResponse |
getVappsForUser(String username,
String companyId,
String locationId)
Get the vApps for a company and user.
|
VappTemplateListResponse |
getVappTemplatesForUser(String username,
String companyId,
String locationId)
Get the vApp templates for a company and user.
|
VccFailoverPlanListResponse |
getVccFailoverPlansForUser(String username,
String companyId,
String locationId)
Get all VCC-R failover plans for a company and user.
|
VdcListResponse |
getVdcsForUser(String username,
String companyId,
String locationId)
Get the vDCs for a company and user.
|
VmListResponse |
getVmsForUser(String username,
String companyId,
String locationId)
Get the VMs for a company and user.
|
ExpandedVpgListResponse |
getVpgsForUser(String username,
String companyId,
String locationId,
List<VpgSubEntityRequest> expand)
Get the VPGs for company and user.
|
void |
removeEntityHistorySubscription(String username,
UserEntityHistorySubscriptionDeleteRequest sub)
Remove an entity history subscription.
|
UserEntityHistorySubscriptionResponse |
subscribeToEntityHistory(String username,
UserEntityHistorySubscriptionCreateRequest sub)
Add an entity history subscription.
|
UserAlertEmailsResponse |
updateAlertEmails(String username,
UserAlertEmailsCreateRequest userAlertEmails)
Store the set of user alerting emails for a given username.
|
void |
updateCompanyRole(String username,
String companyId,
UserRoleUpdateRequest userRoleUpdateRequest)
Update the company role for a specified user.
|
UserPreferencesResponse |
updatePreferences(String username,
UserPreferencesCreateRequest request)
Store / update user preferences section.
|
UserResponse |
updateUser(String username,
UserUpdateRequest request)
Updates a user's information.
|
@GET
@Path(value="/{username}")
UserResponse getUser(@PathParam(value="username")
String username)
username - the user's username@PUT
@Path(value="/{username}")
@Consumes(value="application/json")
UserResponse updateUser(@PathParam(value="username")
String username,
UserUpdateRequest request)
username - the user's username@GET
@Path(value="/{username}/sessions")
UserSessionListResponse getActiveSessions(@PathParam(value="username")
String username)
username - unique username as seen by iland AD@DELETE
@Path(value="/{username}/sessions")
void endAllActiveSessions(@PathParam(value="username")
String username)
username - the username to get sessions for@DELETE
@Path(value="/{username}/sessions/{sessionId}")
void endSession(@PathParam(value="username")
String username,
@PathParam(value="sessionId")
String sessionId)
@GET
@Path(value="/{username}/account-events")
AccountEventListResponse getAccountEvents(@PathParam(value="username")
String username,
@QueryParam(value="offset")
Integer offset,
@QueryParam(value="limit")
Integer limit,
@QueryParam(value="dateFrom")
Long dateFrom,
@QueryParam(value="dateTo")
Long dateTo)
username - String the username of the user@POST
@Path(value="/{username}/actions/subscribe-to-entity-history")
@Consumes(value="application/json")
UserEntityHistorySubscriptionResponse subscribeToEntityHistory(@PathParam(value="username")
String username,
UserEntityHistorySubscriptionCreateRequest sub)
username - usernamesub - subscription details@POST
@Path(value="/{username}/actions/unsubscribe-from-entity-history")
@Consumes(value="application/json")
void removeEntityHistorySubscription(@PathParam(value="username")
String username,
UserEntityHistorySubscriptionDeleteRequest sub)
username - usernamesub - subscription details@GET
@Path(value="/{username}/entity-history-subscriptions")
UserEntityHistorySubscriptionListResponse getEntityHistorySubscriptions(@PathParam(value="username")
String username)
username - username@GET
@Path(value="/{username}/preferences")
UserPreferencesResponse getPreferences(@PathParam(value="username")
String username)
username - username to retrieve preferences for@PUT
@Path(value="/{username}/preferences")
@Consumes(value="application/json")
UserPreferencesResponse updatePreferences(@PathParam(value="username")
String username,
UserPreferencesCreateRequest request)
username - username to store preferences for@DELETE
@Path(value="/{username}")
void delete(@PathParam(value="username")
String username)
username - username of the user to delete@GET
@Path(value="/{username}/login-events")
LoginEventListResponse getLoginEvents(@PathParam(value="username")
String username,
@QueryParam(value="offset")
Integer offset,
@QueryParam(value="limit")
Integer limit)
username - the user's usernameoffset - the offset of the first event to retrievelimit - the limit of the number of login events to retrieve@GET
@Path(value="/{username}/alert-emails")
UserAlertEmailsResponse getUserAlertEmails(@PathParam(value="username")
String username)
This set of emails is used for all alerts (resource and billing, etc) whenever an alert is triggered.
username - the user's username@POST
@Path(value="/{username}/actions/update-alert-emails")
@Consumes(value="application/json")
UserAlertEmailsResponse updateAlertEmails(@PathParam(value="username")
String username,
UserAlertEmailsCreateRequest userAlertEmails)
username - the user's usernameuserAlertEmails - set of alerting emails for the user@GET
@Path(value="/{username}/inventory")
UserInventoryResponse getInventory(@PathParam(value="username")
String username,
@QueryParam(value="company")
String companyId)
username - the username of the usercompanyId - optional company ID parameter that may be used to restrict
the results to just those within a specific company@GET
@Path(value="/{username}/roles/{companyId}")
RoleResponse getCompanyRole(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId)
username - the username of the usercompanyId - the company ID@PUT
@Path(value="/{username}/roles/{companyId}")
@Consumes(value="application/json")
void updateCompanyRole(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
UserRoleUpdateRequest userRoleUpdateRequest)
username - the username of the usercompanyId - the company IDuserRoleUpdateRequest - the data object specifying role update
parameters@DELETE
@Path(value="/{username}/roles/{companyId}")
void deleteCompanyRole(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId)
username - the username of the usercompanyId - the company ID@GET
@Path(value="/{username}/companies")
CompanyListResponse getCompanies(@PathParam(value="username")
String username)
username - the username of the user@GET
@Path(value="/{username}/orgs")
OrgListResponse getAllUserOrgs(@PathParam(value="username")
String username)
username - the username of the user@GET
@Path(value="/{username}/companies/{companyId}/orgs")
OrgListResponse getOrgsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vdcs")
VdcListResponse getVdcsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vapps")
VappListResponse getVappsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vms")
VmListResponse getVmsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/media")
MediaListResponse getMediaForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vapp-templates")
VappTemplateListResponse getVappTemplatesForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/edges")
EdgeListResponse getEdgesForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vpgs")
ExpandedVpgListResponse getVpgsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId,
@QueryParam(value="expand")
List<VpgSubEntityRequest> expand)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vcc-failover-plans")
VccFailoverPlanListResponse getVccFailoverPlansForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vac-companies")
BaCompanySetResponse getBaCompaniesForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/org-vdc-networks")
OrgVdcNetworkListResponse getOrgVdcNetworksForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/vapp-networks")
VappNetworkListResponse getVappNetworksForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/catalogs")
CatalogListResponse getCatalogsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the username of the usercompanyId - the company IDlocationId - the location ID@GET
@Path(value="/{username}/companies/{companyId}/o365-organizations")
O365OrganizationSetResponse getO365OrganizationsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the user namecompanyId - the company identifier (aka CRM # id)locationId - the location identifierO365OrganizationSetResponse instance.@GET
@Path(value="/{username}/companies/{companyId}/o365-jobs")
O365JobSetResponse getO365JobsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the user namecompanyId - the company identifier (aka CRM # id)locationId - the location identifierO365JobSetResponse instance.@GET
@Path(value="/{username}/companies/{companyId}/o365-restore-sessions")
O365RestoreSessionSetResponse getO365ActiveRestoreSessionsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId)
username - the user namecompanyId - the company identifier (aka CRM # id)locationId - the location identifierO365RestoreSessionSetResponse instance.@GET
@Path(value="/{username}/companies/{companyId}/backup-groups")
BackupGroupListResponse getBackupGroupsForUser(@PathParam(value="username")
String username,
@PathParam(value="companyId")
String companyId,
@QueryParam(value="location")
String locationId,
@QueryParam(value="includeSummaryStats")
boolean includeSummaryStats,
@QueryParam(value="includeLastRun")
boolean includeLastRun,
@QueryParam(value="includeBackupPolicy")
boolean includeBackupPolicy)
username - the username of the usercompanyId - the company IDlocationId - the location IDincludeLastRun - whether to include last run infoincludeSummaryStats - whether to include summary stats in the responseincludeBackupPolicy - whether to include backup policy detailsCopyright © 2020 iland Internet Solutions, Corp. All rights reserved.