net.minidev.ovh.api

Class ApiOvhMsServices

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhMsServices

public class ApiOvhMsServices
extends ApiOvhBase

BasePath:https://api.ovh.com/1.0 ResourcePath:/msServices version:1.0

Field Summary

Fields inherited from class net.minidev.ovh.core.ApiOvhBase

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhMsServices(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	GET() List available services REST: GET /msServices API beta
ArrayList<String>	serviceName_account_GET(String serviceName, Long id, String userPrincipalName) Accounts associated to this Active Directory service REST: GET /msServices/{serviceName}/account
OvhTask	serviceName_account_userPrincipalName_changePassword_POST(String serviceName, String userPrincipalName, String password) Change account password REST: POST /msServices/{serviceName}/account/{userPrincipalName}/changePassword
OvhExchangeTask	serviceName_account_userPrincipalName_exchange_configure_POST(String serviceName, String userPrincipalName) Configure mailbox to be operational REST: POST /msServices/{serviceName}/account/{userPrincipalName}/exchange/configure
OvhExchangeInformation	serviceName_account_userPrincipalName_exchange_GET(String serviceName, String userPrincipalName) Get this object properties REST: GET /msServices/{serviceName}/account/{userPrincipalName}/exchange
void	serviceName_account_userPrincipalName_exchange_PUT(String serviceName, String userPrincipalName, OvhExchangeInformation body) Alter this object properties REST: PUT /msServices/{serviceName}/account/{userPrincipalName}/exchange
OvhAccount	serviceName_account_userPrincipalName_GET(String serviceName, String userPrincipalName) Get this object properties REST: GET /msServices/{serviceName}/account/{userPrincipalName}
void	serviceName_account_userPrincipalName_PUT(String serviceName, String userPrincipalName, OvhAccount body) Alter this object properties REST: PUT /msServices/{serviceName}/account/{userPrincipalName}
OvhSharepointTask	serviceName_account_userPrincipalName_sharepoint_clearSpace_POST(String serviceName, String userPrincipalName) On-demand MySite clearance REST: POST /msServices/{serviceName}/account/{userPrincipalName}/sharepoint/clearSpace
OvhSharepointTask	serviceName_account_userPrincipalName_sharepoint_configure_POST(String serviceName, String userPrincipalName) Configure sharepoint account to be operational REST: POST /msServices/{serviceName}/account/{userPrincipalName}/sharepoint/configure
OvhSharepointInformation	serviceName_account_userPrincipalName_sharepoint_GET(String serviceName, String userPrincipalName) Get this object properties REST: GET /msServices/{serviceName}/account/{userPrincipalName}/sharepoint
void	serviceName_account_userPrincipalName_sharepoint_PUT(String serviceName, String userPrincipalName, OvhSharepointInformation body) Alter this object properties REST: PUT /msServices/{serviceName}/account/{userPrincipalName}/sharepoint
OvhExchangeService	serviceName_exchange_GET(String serviceName) Get this object properties REST: GET /msServices/{serviceName}/exchange
void	serviceName_exchange_PUT(String serviceName, OvhExchangeService body) Alter this object properties REST: PUT /msServices/{serviceName}/exchange
ArrayList<Long>	serviceName_exchange_task_GET(String serviceName) Pending actions REST: GET /msServices/{serviceName}/exchange/task
OvhExchangeTask	serviceName_exchange_task_id_GET(String serviceName, Long id) Get this object properties REST: GET /msServices/{serviceName}/exchange/task/{id}
OvhActiveDirectoryOrganizationalUnit	serviceName_GET(String serviceName) Get this object properties REST: GET /msServices/{serviceName}
void	serviceName_PUT(String serviceName, OvhActiveDirectoryOrganizationalUnit body) Alter this object properties REST: PUT /msServices/{serviceName}
OvhSharepointService	serviceName_sharepoint_GET(String serviceName) Get this object properties REST: GET /msServices/{serviceName}/sharepoint
ArrayList<OvhSharepointDailyLicense>	serviceName_sharepoint_license_GET(String serviceName, OvhSharepointLicenseEnum license, OvhLicensePeriodEnum period) Get active licenses for specific period of time REST: GET /msServices/{serviceName}/sharepoint/license
void	serviceName_sharepoint_PUT(String serviceName, OvhSharepointService body) Alter this object properties REST: PUT /msServices/{serviceName}/sharepoint
OvhSharepointTask	serviceName_sharepoint_restoreAdminRights_POST(String serviceName) Restore administrator rights REST: POST /msServices/{serviceName}/sharepoint/restoreAdminRights
ArrayList<Long>	serviceName_sharepoint_task_GET(String serviceName, String function, OvhTaskStatusEnum status) Pending actions REST: GET /msServices/{serviceName}/sharepoint/task
OvhSharepointTask	serviceName_sharepoint_task_id_GET(String serviceName, Long id) Get this object properties REST: GET /msServices/{serviceName}/sharepoint/task/{id}
ArrayList<Long>	serviceName_task_GET(String serviceName, OvhTaskFunctionEnum function, OvhTaskStatusEnum status) Pending actions REST: GET /msServices/{serviceName}/task
OvhTask	serviceName_task_id_GET(String serviceName, Long id) Get this object properties REST: GET /msServices/{serviceName}/task/{id}
ArrayList<String>	serviceName_upnSuffix_GET(String serviceName) active directory UPN suffix REST: GET /msServices/{serviceName}/upnSuffix
OvhTask	serviceName_upnSuffix_POST(String serviceName, String suffix) Create new UPN suffix REST: POST /msServices/{serviceName}/upnSuffix
OvhTask	serviceName_upnSuffix_suffix_DELETE(String serviceName, String suffix) Delete existing UPN suffix REST: DELETE /msServices/{serviceName}/upnSuffix/{suffix}
OvhUpnSuffix	serviceName_upnSuffix_suffix_GET(String serviceName, String suffix) Get this object properties REST: GET /msServices/{serviceName}/upnSuffix/{suffix}

Methods inherited from class net.minidev.ovh.core.ApiOvhBase

addBody, convertTo, convertTo, exec, exec, execN, execN, getNic, path, query

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiOvhMsServices

public ApiOvhMsServices(ApiOvhCore core)

Method Detail

serviceName_GET

public OvhActiveDirectoryOrganizationalUnit serviceName_GET(String serviceName)
                                                     throws IOException

Get this object properties REST: GET /msServices/{serviceName}

Parameters:

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_PUT

public void serviceName_PUT(String serviceName,
                            OvhActiveDirectoryOrganizationalUnit body)
                     throws IOException

Alter this object properties REST: PUT /msServices/{serviceName}

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_upnSuffix_GET

public ArrayList<String> serviceName_upnSuffix_GET(String serviceName)
                                            throws IOException

active directory UPN suffix REST: GET /msServices/{serviceName}/upnSuffix

Parameters:

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_upnSuffix_POST

public OvhTask serviceName_upnSuffix_POST(String serviceName,
                                          String suffix)
                                   throws IOException

Create new UPN suffix REST: POST /msServices/{serviceName}/upnSuffix

Parameters:

suffix - [required] UPN suffix to create

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_upnSuffix_suffix_GET

public OvhUpnSuffix serviceName_upnSuffix_suffix_GET(String serviceName,
                                                     String suffix)
                                              throws IOException

Get this object properties REST: GET /msServices/{serviceName}/upnSuffix/{suffix}

Parameters:

serviceName - [required] The internal name of your Active Directory organization

suffix - [required] UPN suffix API beta

Throws:

IOException

serviceName_upnSuffix_suffix_DELETE

public OvhTask serviceName_upnSuffix_suffix_DELETE(String serviceName,
                                                   String suffix)
                                            throws IOException

Delete existing UPN suffix REST: DELETE /msServices/{serviceName}/upnSuffix/{suffix}

Parameters:

serviceName - [required] The internal name of your Active Directory organization

suffix - [required] UPN suffix API beta

Throws:

IOException

serviceName_account_userPrincipalName_GET

public OvhAccount serviceName_account_userPrincipalName_GET(String serviceName,
                                                            String userPrincipalName)
                                                     throws IOException

Get this object properties REST: GET /msServices/{serviceName}/account/{userPrincipalName}

Parameters:

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_PUT

public void serviceName_account_userPrincipalName_PUT(String serviceName,
                                                      String userPrincipalName,
                                                      OvhAccount body)
                                               throws IOException

Alter this object properties REST: PUT /msServices/{serviceName}/account/{userPrincipalName}

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_sharepoint_GET

public OvhSharepointInformation serviceName_account_userPrincipalName_sharepoint_GET(String serviceName,
                                                                                     String userPrincipalName)
                                                                              throws IOException

Get this object properties REST: GET /msServices/{serviceName}/account/{userPrincipalName}/sharepoint

Parameters:

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_sharepoint_PUT

public void serviceName_account_userPrincipalName_sharepoint_PUT(String serviceName,
                                                                 String userPrincipalName,
                                                                 OvhSharepointInformation body)
                                                          throws IOException

Alter this object properties REST: PUT /msServices/{serviceName}/account/{userPrincipalName}/sharepoint

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_sharepoint_clearSpace_POST

public OvhSharepointTask serviceName_account_userPrincipalName_sharepoint_clearSpace_POST(String serviceName,
                                                                                          String userPrincipalName)
                                                                                   throws IOException

On-demand MySite clearance REST: POST /msServices/{serviceName}/account/{userPrincipalName}/sharepoint/clearSpace

Parameters:

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_sharepoint_configure_POST

public OvhSharepointTask serviceName_account_userPrincipalName_sharepoint_configure_POST(String serviceName,
                                                                                         String userPrincipalName)
                                                                                  throws IOException

Configure sharepoint account to be operational REST: POST /msServices/{serviceName}/account/{userPrincipalName}/sharepoint/configure

Parameters:

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_changePassword_POST

public OvhTask serviceName_account_userPrincipalName_changePassword_POST(String serviceName,
                                                                         String userPrincipalName,
                                                                         String password)
                                                                  throws IOException

Change account password REST: POST /msServices/{serviceName}/account/{userPrincipalName}/changePassword

Parameters:

password - [required] new password

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_exchange_GET

public OvhExchangeInformation serviceName_account_userPrincipalName_exchange_GET(String serviceName,
                                                                                 String userPrincipalName)
                                                                          throws IOException

Get this object properties REST: GET /msServices/{serviceName}/account/{userPrincipalName}/exchange

Parameters:

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_exchange_PUT

public void serviceName_account_userPrincipalName_exchange_PUT(String serviceName,
                                                               String userPrincipalName,
                                                               OvhExchangeInformation body)
                                                        throws IOException

Alter this object properties REST: PUT /msServices/{serviceName}/account/{userPrincipalName}/exchange

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_userPrincipalName_exchange_configure_POST

public OvhExchangeTask serviceName_account_userPrincipalName_exchange_configure_POST(String serviceName,
                                                                                     String userPrincipalName)
                                                                              throws IOException

Configure mailbox to be operational REST: POST /msServices/{serviceName}/account/{userPrincipalName}/exchange/configure

Parameters:

serviceName - [required] The internal name of your Active Directory organization

userPrincipalName - [required] User Principal Name API beta

Throws:

IOException

serviceName_account_GET

public ArrayList<String> serviceName_account_GET(String serviceName,
                                                 Long id,
                                                 String userPrincipalName)
                                          throws IOException

Accounts associated to this Active Directory service REST: GET /msServices/{serviceName}/account

Parameters:

id - [required] Filter the value of id property (like)

userPrincipalName - [required] Filter the value of userPrincipalName property (like)

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_sharepoint_GET

public OvhSharepointService serviceName_sharepoint_GET(String serviceName)
                                                throws IOException

Get this object properties REST: GET /msServices/{serviceName}/sharepoint

Parameters:

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_sharepoint_PUT

public void serviceName_sharepoint_PUT(String serviceName,
                                       OvhSharepointService body)
                                throws IOException

Alter this object properties REST: PUT /msServices/{serviceName}/sharepoint

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_sharepoint_restoreAdminRights_POST

public OvhSharepointTask serviceName_sharepoint_restoreAdminRights_POST(String serviceName)
                                                                 throws IOException

Restore administrator rights REST: POST /msServices/{serviceName}/sharepoint/restoreAdminRights

Parameters:

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_sharepoint_task_GET

public ArrayList<Long> serviceName_sharepoint_task_GET(String serviceName,
                                                       String function,
                                                       OvhTaskStatusEnum status)
                                                throws IOException

Pending actions REST: GET /msServices/{serviceName}/sharepoint/task

Parameters:

function - [required] Filter the value of function property (like)

status - [required] Filter the value of status property (=)

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_sharepoint_task_id_GET

public OvhSharepointTask serviceName_sharepoint_task_id_GET(String serviceName,
                                                            Long id)
                                                     throws IOException

Get this object properties REST: GET /msServices/{serviceName}/sharepoint/task/{id}

Parameters:

serviceName - [required] The internal name of your Active Directory organization

id - [required] Task id API beta

Throws:

IOException

serviceName_sharepoint_license_GET

public ArrayList<OvhSharepointDailyLicense> serviceName_sharepoint_license_GET(String serviceName,
                                                                               OvhSharepointLicenseEnum license,
                                                                               OvhLicensePeriodEnum period)
                                                                        throws IOException

Get active licenses for specific period of time REST: GET /msServices/{serviceName}/sharepoint/license

Parameters:

period - [required] Period of time used to determine sharepoint account license statistics

license - [required] License type

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_task_GET

public ArrayList<Long> serviceName_task_GET(String serviceName,
                                            OvhTaskFunctionEnum function,
                                            OvhTaskStatusEnum status)
                                     throws IOException

Pending actions REST: GET /msServices/{serviceName}/task

Parameters:

function - [required] Filter the value of function property (=)

status - [required] Filter the value of status property (=)

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_task_id_GET

public OvhTask serviceName_task_id_GET(String serviceName,
                                       Long id)
                                throws IOException

Get this object properties REST: GET /msServices/{serviceName}/task/{id}

Parameters:

serviceName - [required] The internal name of your Active Directory organization

id - [required] Task id API beta

Throws:

IOException

serviceName_exchange_GET

public OvhExchangeService serviceName_exchange_GET(String serviceName)
                                            throws IOException

Get this object properties REST: GET /msServices/{serviceName}/exchange

Parameters:

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_exchange_PUT

public void serviceName_exchange_PUT(String serviceName,
                                     OvhExchangeService body)
                              throws IOException

Alter this object properties REST: PUT /msServices/{serviceName}/exchange

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_exchange_task_GET

public ArrayList<Long> serviceName_exchange_task_GET(String serviceName)
                                              throws IOException

Pending actions REST: GET /msServices/{serviceName}/exchange/task

Parameters:

serviceName - [required] The internal name of your Active Directory organization API beta

Throws:

IOException

serviceName_exchange_task_id_GET

public OvhExchangeTask serviceName_exchange_task_id_GET(String serviceName,
                                                        Long id)
                                                 throws IOException

Get this object properties REST: GET /msServices/{serviceName}/exchange/task/{id}

Parameters:

serviceName - [required] The internal name of your Active Directory organization

id - [required] Task id API beta

Throws:

IOException

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /msServices API beta

Throws:

IOException