com.iland.core.web.rest.api

Interface CompanyResource

@Path(value="/companies")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface CompanyResource

Company Resource Interface.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
RoleResponse	createRole(String companyId, RoleCreateRequest roleCreationRequest) Creates a new role for a company.
UserResponse	createSSOUser(String companyId, SSOUserCreateRequest createRequest) Create a new SSO user for a company.
UserCreationSetResponse	createSSOUsers(String companyId, SSOUserCreateRequestSet ssoUserCreateRequestSet) Create multiple SSO users for a company.
UserCreationSetResponse	createSSOUsersFromFile(String companyId, byte[] ssoCSVFile) Create multiple SSO users from a CSV file.
UserResponse	createUser(String companyId, UserCreateRequest createRequest) Creates a new user for a company.
UserCreationSetResponse	createUsers(String companyId, UserCreateRequestSet userCreateRequestSet) Create multiple users for a company.
UserCreationSetResponse	createUsersFromFile(String companyId, byte[] userCSVFile) Create multiple users from a file.
void	deleteRole(String companyId, String roleId) Deletes a company role.
InputStream	downloadExampleUserCreationCSVFile(String companyId, boolean ssoUsers) Download an example of the user creation CSV file.
void	enforceTwoFactorAuthForUser(String companyId, EnforceTwoFactorAuthForUserRequest request) Enforce two factor authentication for the specified user.
CloudTenantBillHistoryResponse	getBaCompanyBillingHistory(String companyId, String locationId, Integer startYear, Integer startMonth, Integer endYear, Integer endMonth) Get the historical VAC billing for a given company.
CloudTenantBillHistoryResponse	getCloudTenantBillingHistory(String companyId, String locationId, Integer startYear, Integer startMonth, Integer endYear, Integer endMonth) Get the historical billing for a given company.
CompanyResponse	getCompany(String companyId) Gets a company.
CompanyAdminCountResponse	getCompanyAdminCount(String companyId) Get the number of company admins in a given company.
CompanyTwoFactorAuthSettingsResponse	getCompanyTwoFactorAuthSettings(String companyId) Get the specified company's two factor authentication settings.
InputStream	getLogo(String companyId) Gets the company logo.
ObjectStorageAccountInfoResponse	getObjectStorageAccountInfo(String companyId) Gets a simple summary for a company's object storage account quote and used quota
RoleResponse	getRoleResponse(String companyId, String roleId) Gets a company role by ID.
RoleListResponse	getRoles(String companyId) Gets all company roles.
StringListResponse	getUserDomains(String companyId) Get the user domains that are associated with this company.
CompanyUserListResponse	getUsers(String companyId, String roleId) Gets all users for a company.
BaCompanySetResponse	getVacCompanies(String companyId) Get all the VAC companies for a given company.
void	markUserAsInvited(String companyId, String username) Mark a given user without sending an invitation email.
void	removeCompanyLogo(String companyId) Removes the company's logo.
void	resetTwoFactorAuthForUser(String companyId, ResetTwoFactorAuthRequest request) Reset two factor authentication for the specified user.
void	resetUserPassword(String companyId, String username) Reset a user's password and send them an email allowing them to reset their password.
SearchResultResponse	search(String companyId, String query, int pageOffset, int pageSize) Perform a full-text search of entities pertaining to this company.
void	sendUserInvitationEmail(String companyId, String username) Send a user invitation email to the given user.
void	sendUsersInvitationEmails(String companyId, InviteUserEmailSet userNames) Send user invitation emails to the given set of users.
void	setCompanyTwoFactorAuthSettings(String companyId, EnforceTwoFactorAuthRequest request) Set the two factor authentication settings for a company.
void	updateCompanyLogo(String companyId, byte[] pictureBytes) Updates the company's logo.
RoleResponse	updateRole(String companyId, String roleId, RoleUpdateRequest roleUpdateRequest) Modifies a company role.

Method Detail

getCompany

@GET
 @Path(value="/{companyId}")
CompanyResponse getCompany(@PathParam(value="companyId")
                                                             String companyId)

Gets a company.

Parameters:

companyId - String the company identifier

Returns:

the company details

createUser

@POST
 @Path(value="/{companyId}/users")
 @Consumes(value="application/json")
UserResponse createUser(@PathParam(value="companyId")
                                                                                                      String companyId,
                                                                                                      UserCreateRequest createRequest)

Creates a new user for a company.

Parameters:

createRequest - new user details

Returns:

created user

createSSOUser

@POST
 @Path(value="/{companyId}/sso-user")
 @Consumes(value="application/json")
UserResponse createSSOUser(@PathParam(value="companyId")
                                                                                                            String companyId,
                                                                                                            SSOUserCreateRequest createRequest)

Create a new SSO user for a company.

Parameters:

companyId - company to create users in

createRequest - new user details

Returns:

created user

createUsers

@POST
 @Path(value="/{companyId}/users-batch")
 @Consumes(value="application/json")
UserCreationSetResponse createUsers(@PathParam(value="companyId")
                                                                                                                        String companyId,
                                                                                                                        UserCreateRequestSet userCreateRequestSet)

Create multiple users for a company.

Parameters:

companyId - company to create users in

userCreateRequestSet - set of new user details

createSSOUsers

@POST
 @Path(value="/{companyId}/users-sso-batch")
 @Consumes(value="application/json")
UserCreationSetResponse createSSOUsers(@PathParam(value="companyId")
                                                                                                                               String companyId,
                                                                                                                               SSOUserCreateRequestSet ssoUserCreateRequestSet)

Create multiple SSO users for a company.

Parameters:

companyId - company to create users in

ssoUserCreateRequestSet - set of new SSO user details

createUsersFromFile

@POST
 @Path(value="/{companyId}/create-users-from-file")
 @Consumes(value="application/json")
UserCreationSetResponse createUsersFromFile(@PathParam(value="companyId")
                                                                                                                                           String companyId,
                                                                                                                                           byte[] userCSVFile)

Create multiple users from a file. To see an exmaple of a valid CSV file see downloadExampleUserCreationCSVFile(String, boolean) where the boolean is set to false.

Parameters:

companyId - company to create users in

userCSVFile - file to import users from

createSSOUsersFromFile

@POST
 @Path(value="/{companyId}/create-sso-users-from-file")
 @Consumes(value="application/json")
UserCreationSetResponse createSSOUsersFromFile(@PathParam(value="companyId")
                                                                                                                                                  String companyId,
                                                                                                                                                  byte[] ssoCSVFile)

Create multiple SSO users from a CSV file. To see an example of valid CSV file see downloadExampleUserCreationCSVFile(String, boolean) where the SSO boolean flag is set to true.

Parameters:

companyId - company to create users in

ssoCSVFile - file to import users from

downloadExampleUserCreationCSVFile

@POST
 @Path(value="/{companyId}/download-user-create-csv-example")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream downloadExampleUserCreationCSVFile(@PathParam(value="companyId")
                                                                                                                                                                                                                             String companyId,
                                                                                                                                                                                                                             @QueryParam(value="ssoUsers")
                                                                                                                                                                                                                             boolean ssoUsers)

Download an example of the user creation CSV file. Will include all the domains and all the roles you can use.

Parameters:

companyId - company of the example csv file

Returns:

example CSV file for user creation

getUsers

@GET
 @Path(value="/{companyId}/users")
CompanyUserListResponse getUsers(@PathParam(value="companyId")
                                                                         String companyId,
                                                                         @QueryParam(value="role")
                                                                         String roleId)

Gets all users for a company.

Parameters:

companyId - the company identifier

Returns:

list of the companies users

createRole

@POST
 @Path(value="/{companyId}/roles")
 @Consumes(value="application/json")
RoleResponse createRole(@PathParam(value="companyId")
                                                                                                      String companyId,
                                                                                                      RoleCreateRequest roleCreationRequest)

Creates a new role for a company.

Parameters:

companyId - the company ID

roleCreationRequest - data object specifying new role parameters

Returns:

created role

getRoles

@GET
 @Path(value="/{companyId}/roles")
RoleListResponse getRoles(@PathParam(value="companyId")
                                                                  String companyId)

Gets all company roles.

Parameters:

companyId - the company ID

Returns:

the list of company roles

getRoleResponse

@GET
 @Path(value="/{companyId}/roles/{roleId}")
RoleResponse getRoleResponse(@PathParam(value="companyId")
                                                                              String companyId,
                                                                              @PathParam(value="roleId")
                                                                              String roleId)

Gets a company role by ID.

Parameters:

companyId - the company ID

roleId - the role ID

Returns:

the role details

updateRole

@PUT
 @Path(value="/{companyId}/roles/{roleId}")
 @Consumes(value="application/json")
RoleResponse updateRole(@PathParam(value="companyId")
                                                                                                              String companyId,
                                                                                                              @PathParam(value="roleId")
                                                                                                              String roleId,
                                                                                                              RoleUpdateRequest roleUpdateRequest)

Modifies a company role.

Parameters:

companyId - the company ID

roleId - the role ID

roleUpdateRequest - data object with role update parameters

Returns:

the role details

deleteRole

@DELETE
 @Path(value="/{companyId}/roles/{roleId}")
void deleteRole(@PathParam(value="companyId")
                                                                    String companyId,
                                                                    @PathParam(value="roleId")
                                                                    String roleId)

Deletes a company role.

Parameters:

companyId - the company ID

roleId - the role ID

getUserDomains

@GET
 @Path(value="/{companyId}/user-domains")
StringListResponse getUserDomains(@PathParam(value="companyId")
                                                                                 String companyId)

Get the user domains that are associated with this company.

Parameters:

companyId - the company identifier

Returns:

list of domains that are associated with the company

getCloudTenantBillingHistory

@GET
 @Path(value="/{companyId}/vcc-backup-tenants-billing")
CloudTenantBillHistoryResponse getCloudTenantBillingHistory(@PathParam(value="companyId")
                                                                                                                         String companyId,
                                                                                                                         @QueryParam(value="location")
                                                                                                                         String locationId,
                                                                                                                         @QueryParam(value="startYear")
                                                                                                                         Integer startYear,
                                                                                                                         @QueryParam(value="startMonth")
                                                                                                                         Integer startMonth,
                                                                                                                         @QueryParam(value="endYear")
                                                                                                                         Integer endYear,
                                                                                                                         @QueryParam(value="endMonth")
                                                                                                                         Integer endMonth)

Get the historical billing for a given company.

Parameters:

companyId - the company identifier

locationId - the location identifier (optional)

startYear - the year to start

startMonth - the month to start (1-12)

endYear - the year to end with

endMonth - the month to end (1-12)

Returns:

map of location to list of bills

getBaCompanyBillingHistory

@GET
 @Path(value="/{companyId}/vac-backup-tenants-billing")
CloudTenantBillHistoryResponse getBaCompanyBillingHistory(@PathParam(value="companyId")
                                                                                                                       String companyId,
                                                                                                                       @QueryParam(value="location")
                                                                                                                       String locationId,
                                                                                                                       @QueryParam(value="startYear")
                                                                                                                       Integer startYear,
                                                                                                                       @QueryParam(value="startMonth")
                                                                                                                       Integer startMonth,
                                                                                                                       @QueryParam(value="endYear")
                                                                                                                       Integer endYear,
                                                                                                                       @QueryParam(value="endMonth")
                                                                                                                       Integer endMonth)

Get the historical VAC billing for a given company.

Parameters:

companyId - the company identifier

locationId - the location identifier (optional)

startYear - the year to start

startMonth - the month to start (1-12)

endYear - the year to end with

endMonth - the month to end (1-12)

Returns:

map of location to list of vac bills

updateCompanyLogo

@POST
 @Path(value="/{companyId}/logo")
 @Consumes(value="image/jpeg")
void updateCompanyLogo(@PathParam(value="companyId")
                                                                                              String companyId,
                                                                                              byte[] pictureBytes)

Updates the company's logo.

Parameters:

companyId - the company identifier

pictureBytes - a JPEG image

removeCompanyLogo

@DELETE
 @Path(value="/{companyId}/logo")
void removeCompanyLogo(@PathParam(value="companyId")
                                                                 String companyId)

Removes the company's logo.

Parameters:

companyId - the company identifier

getLogo

@GET
 @Path(value="/{companyId}/logo")
 @Produces(value="image/vnd.ilandcloud.api.v1.0+jpeg")
InputStream getLogo(@PathParam(value="companyId")
                                                                                                                  String companyId)

Gets the company logo.

Parameters:

companyId - String the company identifier

Returns:

the picture as a byte array

search

@GET
 @Path(value="/{companyId}/search")
SearchResultResponse search(@PathParam(value="companyId")
                                                                     String companyId,
                                                                     @QueryParam(value="query")
                                                                     String query,
                                                                     @QueryParam(value="pageOffset")
                                                                     int pageOffset,
                                                                     @QueryParam(value="pageSize")
                                                                     int pageSize)

Perform a full-text search of entities pertaining to this company.

Parameters:

companyId - String the company identifier

query - query string

The query string accepts Lucene style query input.

For example to search for networks with IPs in the 10.10.10.X subnet you would supply '10.10.10.*' as a query string. Tht * represents a wildcard character and can be used anywhere in a query EXCEPT for as the first character.

To search for multiple terms that MUST occur the AND operator can be used. E.g. to find documents containing both 'network' and 'vapp' you would supply the query string 'network AND vapp' .

pageOffset - page offset for return documents

pageSize - limit to number of hits (default value is 10 and maximum is 50)

getVacCompanies

@GET
 @Path(value="/{companyId}/vac-companies")
BaCompanySetResponse getVacCompanies(@PathParam(value="companyId")
                                                                                     String companyId)

Get all the VAC companies for a given company.

Parameters:

companyId - company id

Returns:

a set of vac companies

enforceTwoFactorAuthForUser

@POST
 @Path(value="/{companyId}/actions/enforce-two-factor-auth")
void enforceTwoFactorAuthForUser(@PathParam(value="companyId")
                                                                                                    String companyId,
                                                                                                    EnforceTwoFactorAuthForUserRequest request)

Enforce two factor authentication for the specified user.

Parameters:

companyId - company id

request - request to enforce two factor auth for user

resetTwoFactorAuthForUser

@POST
 @Path(value="/{companyId}/actions/reset-two-factor-auth")
void resetTwoFactorAuthForUser(@PathParam(value="companyId")
                                                                                                String companyId,
                                                                                                ResetTwoFactorAuthRequest request)

Reset two factor authentication for the specified user. After resetting the user's two factor auth credentials, will default back to the global settings for the company regarding two factor authentication.

Parameters:

companyId - company id

request - request to reset two factor auth for user

setCompanyTwoFactorAuthSettings

@PUT
 @Path(value="/{companyId}/two-factor-auth-settings")
void setCompanyTwoFactorAuthSettings(@PathParam(value="companyId")
                                                                                                String companyId,
                                                                                                EnforceTwoFactorAuthRequest request)

Set the two factor authentication settings for a company. Can either set for all users in the company or for specified roles.

Parameters:

companyId - company id

request - request whether to enforce for all users or specified roles

getCompanyTwoFactorAuthSettings

@GET
 @Path(value="/{companyId}/two-factor-auth-settings")
CompanyTwoFactorAuthSettingsResponse getCompanyTwoFactorAuthSettings(@PathParam(value="companyId")
                                                                                                                                String companyId)

Get the specified company's two factor authentication settings.

Parameters:

companyId - company id

Returns:

company's two factor auth settings

sendUserInvitationEmail

@POST
 @Path(value="/{companyId}/actions/{username}/send-invite-email")
void sendUserInvitationEmail(@PathParam(value="companyId")
                                                                                                     String companyId,
                                                                                                     @PathParam(value="username")
                                                                                                     String username)

Send a user invitation email to the given user.

Parameters:

companyId - company id

username - user to send invite email to

markUserAsInvited

@POST
 @Path(value="/{companyId}/actions/{username}/mark-as-invited")
void markUserAsInvited(@PathParam(value="companyId")
                                                                                             String companyId,
                                                                                             @PathParam(value="username")
                                                                                             String username)

Mark a given user without sending an invitation email.

Parameters:

companyId - company id

username - user to be marked as invited

sendUsersInvitationEmails

@POST
 @Path(value="/{companyId}/actions/send-invite-emails")
void sendUsersInvitationEmails(@PathParam(value="companyId")
                                                                                             String companyId,
                                                                                             InviteUserEmailSet userNames)

Send user invitation emails to the given set of users.

Parameters:

companyId - company id

userNames - users to send invite emails to

getCompanyAdminCount

@GET
 @Path(value="/{companyId}/company-admin-count")
CompanyAdminCountResponse getCompanyAdminCount(@PathParam(value="companyId")
                                                                                                     String companyId)

Get the number of company admins in a given company.

Parameters:

companyId - company id

Returns:

number of company admins in company

resetUserPassword

@POST
 @Path(value="/{companyId}/actions/{username}/reset-users-password")
void resetUserPassword(@PathParam(value="companyId")
                                                                                                  String companyId,
                                                                                                  @PathParam(value="username")
                                                                                                  String username)

Reset a user's password and send them an email allowing them to reset their password.

Parameters:

companyId - company id

username - user to send reset password email to

getObjectStorageAccountInfo

@GET
 @Path(value="/{companyId}/object-storage-account-info")
ObjectStorageAccountInfoResponse getObjectStorageAccountInfo(@PathParam(value="companyId")
                                                                                                                           String companyId)

Gets a simple summary for a company's object storage account quote and used quota

Parameters:

companyId - String company ID