{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"email.exchange.CountryCodeEnum":{"type":"string","description":"Country Code iso","enum":["AC","AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"email.exchange.ExchangeRemoteMailboxTypeEnum":{"type":"string","description":"Type of the remote mailbox","enum":["equipment","regular","room"]},"email.exchange.ObjectStateEnum":{"type":"string","description":"Current object state","enum":["creating","deleting","internalMigration","ok","reopening","suspended","suspending"]},"email.exchange.Task":{"type":"object","description":"Exchange task details","properties":{"finishDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/email.exchange.TaskFunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"Task id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/email.exchange.TaskStatusEnum"}],"description":"Task status","readOnly":true},"todoDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true}}},"email.exchange.TaskFunctionEnum":{"type":"string","description":"function enumeration for exchange task","enum":["activateSharepoint","addAccount","addAccountArchive","addAccountImpersonation","addActiveSyncMailNotification","addAlias","addDistributionGroup","addDistributionGroupManager","addDistributionGroupMember","addDistributionGroupSendAs","addDistributionGroupSendOnBehalfTo","addDomain","addDomainDisclaimer","addExchangeCustomIsolation","addExchangeDomainDKIM","addExchangeRemoteMailbox","addExchangeServiceAuthorizedIp","addExportPstRequest","addExternalContact","addFullAccess","addOutlookLicense","addPublicFolder","addPublicFolderPermission","addResourceAccount","addResourceDelegate","addSendAs","addSendConnector","addSendOnBehalfTo","addSharedAccount","addSharedAccountFullAccess","addSharedAccountSendAs","addSharedAccountSendOnBehalfTo","changeHostname","changePassword","clearDataOnDevice","cloneTemplateExchangePrivate","configureExchangeCustomer","configureExchangeOwaMfa","copyMailbox","createExternalAntiSpamReceiveConnector","deleteAccount","deleteAccountArchive","deleteAccountImpersonation","deleteActiveSyncMailNotification","deleteAlias","deleteDistributionGroup","deleteDistributionGroupManager","deleteDistributionGroupMember","deleteDistributionGroupSendAs","deleteDistributionGroupSendOnBehalfTo","deleteDomain","deleteDomainDisclaimer","deleteExchangeCustomIsolation","deleteExchangeDomainDKIM","deleteExchangeRemoteMailbox","deleteExchangeService","deleteExchangeServiceAuthorizedIp","deleteExportPstRequest","deleteExternalAntiSpamReceiveConnector","deleteExternalContact","deleteFullAccess","deleteOutlookLicense","deletePublicFolder","deletePublicFolderPermission","deleteResourceAccount","deleteResourceDelegate","deleteSendAs","deleteSendConnector","deleteSendOnBehalfTo","deleteSharedAccount","deleteSharedAccountFullAccess","deleteSharedAccountSendAs","deleteSharedAccountSendOnBehalfTo","destroyPrivateVm","diagnoseAccount","disableExchangeDKIM","enableExchangeDKIM","expandDrive","generateOutlookUrl","generatePstUrl","installExchange","installSSL","maintenance","migrationAccount","migrationDisclaimer","migrationExternalContact","migrationHistory","migrationMailingList","migrationResourceAccount","migrationService","reOpenHostedAccount","reOpenOutlookLicense","reOpenPrivateAccount","reOpenPrivateVm","setAccount","setAccountArchive","setAlias","setDistributionGroup","setDns","setDomain","setDomainDisclaimer","setExchangeAccountProtocol","setExchangeRemoteMailbox","setExchangeServiceDevice","setExternalAntiSpamReceiveConnector","setExternalContact","setPublicFolder","setPublicFolderPermission","setResourceAccount","setSendConnector","setService","setSharedAccount","suspendAccount","suspendExchangeService","suspendHostedAccount","suspendOutlookLicense","suspendPrivateAccount","suspendPrivateVm","unsuspendAccount","unsuspendExchangeService","unsuspendHostedAccount","updateExchangeServiceDevice","upgrade2016"]},"email.exchange.TaskStatusEnum":{"type":"string","description":"Exchange task status","enum":["cancelled","doing","done","error","todo"]},"email.exchange.exchangeRemoteMailbox":{"type":"object","description":"Exchange remote mailbox","properties":{"SAMAccountName":{"type":"string","description":"SAM account name","nullable":true,"readOnly":true},"city":{"type":"string","description":"city","nullable":true},"company":{"type":"string","description":"Company name","nullable":true},"countryCode":{"allOf":[{"$ref":"#/components/schemas/email.exchange.CountryCodeEnum"}],"description":"Country code","nullable":true},"creationDate":{"type":"string","description":"Creation date","nullable":true,"format":"date-time","readOnly":true},"description":{"type":"string","description":"Description","nullable":true},"displayName":{"type":"string","description":"Remote mailbox display name","nullable":true},"domain":{"type":"string","description":"Remote mailbox domain"},"exchangeGuid":{"type":"string","description":"exchangeGuid for manual configuration","nullable":true,"readOnly":true},"fax":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Fax number","nullable":true},"firstName":{"type":"string","description":"Remote mailbox first name","nullable":true},"guid":{"type":"string","description":"GUID for user in active directory","nullable":true,"readOnly":true},"hiddenFromGAL":{"type":"boolean","description":"Hide remote mailbox  in Global Address List"},"id":{"type":"integer","description":"Remote mailbox id","readOnly":true},"initial":{"type":"string","description":"Remote mailbox initials","nullable":true},"jobDepartment":{"type":"string","description":"Job Department","nullable":true},"jobTitle":{"type":"string","description":"Job title","nullable":true},"lastName":{"type":"string","description":"Remote mailbox last name","nullable":true},"login":{"type":"string","description":"Remote mailbox login"},"mobile":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Mobile phone","nullable":true},"numberOfAliases":{"type":"integer","description":"Count the number of related aliases attached to this account","readOnly":true},"office":{"type":"string","description":"Job office","nullable":true},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Phone number","nullable":true},"postalCode":{"type":"string","description":"Postal code","nullable":true},"primaryEmailAddress":{"type":"string","description":"Default email for this mailbox","readOnly":true},"region":{"type":"string","description":"region","nullable":true},"remoteRoutingAddress":{"type":"string","description":"Email address of associated mailbox","readOnly":true},"spamAndVirusConfiguration":{"allOf":[{"$ref":"#/components/schemas/email.exchange.spamAndVirusConfiguration"}],"description":"Spam and Antivirus configuration"},"state":{"allOf":[{"$ref":"#/components/schemas/email.exchange.ObjectStateEnum"}],"description":"Remote mailbox state","readOnly":true},"streetAddress":{"type":"string","description":"Street address","nullable":true},"taskPendingId":{"type":"integer","description":"Pending task for this remote mailbox","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/email.exchange.ExchangeRemoteMailboxTypeEnum"}],"description":"Type of mailbox","readOnly":true}}},"email.exchange.exchangeRemoteMailboxAlias":{"type":"object","description":"Aliases on this remote mailbox","properties":{"alias":{"type":"string","description":"Alias","readOnly":true},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"taskPendingId":{"type":"integer","description":"Pending task id","nullable":true,"readOnly":true}}},"email.exchange.spamAndVirusConfiguration":{"type":"object","description":"Spam and Antyvirus configuration","properties":{"checkDKIM":{"type":"boolean","description":"Check DKIM of message"},"checkSPF":{"type":"boolean","description":"Check SPF of message"},"deleteSpam":{"type":"boolean","description":"If message is a spam delete it"},"deleteVirus":{"type":"boolean","description":"If message is a virus delete it"},"putInJunk":{"type":"boolean","description":"If message is a spam or virus put in junk. Overridden by deleteSpam or deleteVirus"},"tagSpam":{"type":"boolean","description":"If message is a spam change its subject"},"tagVirus":{"type":"boolean","description":"If message is a virus change its subject"}}},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox":{"get":{"summary":"List remote mailboxes","description":"List remote mailboxes. Returns the primary email addresses of the remote mailboxes. Filter them by `primaryEmailAddress` or `id`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"query","name":"id","description":"Filter the value of id property (like)","schema":{"type":"integer"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"query","name":"primaryEmailAddress","description":"Filter the value of primaryEmailAddress property (like)","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@10"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/get","required":true}],"x-expanded-response":"EmailExchangeExchangeRemoteMailbox"},"post":{"summary":"Create a remote mailbox","description":"Create a remote mailbox. Creates a regular, room or equipment remote mailbox from a `login`, a `domain`, a `password`, an `exchangeGuid` and the `remoteRoutingAddress` of the associated mailbox, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","description":"City"},"company":{"type":"string","description":"Company name"},"countryCode":{"description":"Country code","$ref":"#/components/schemas/email.exchange.CountryCodeEnum"},"description":{"type":"string","description":"Description"},"displayName":{"type":"string","description":"Display name"},"domain":{"type":"string","description":"Email domain"},"exchangeGuid":{"type":"string","description":"Remote exchangeGuid"},"fax":{"description":"Fax number","$ref":"#/components/schemas/phoneNumber"},"firstName":{"type":"string","description":"First name"},"hiddenFromGAL":{"type":"boolean","description":"Hide the remote mailbox in Global Address List"},"initials":{"type":"string","description":"Initials"},"jobDepartment":{"type":"string","description":"Job department"},"jobTitle":{"type":"string","description":"Job title"},"lastName":{"type":"string","description":"Last name"},"login":{"type":"string","description":"Login"},"mobile":{"description":"Mobile phone number","$ref":"#/components/schemas/phoneNumber"},"office":{"type":"string","description":"Office"},"password":{"type":"string","description":"Password","format":"password"},"phone":{"description":"Phone Number","$ref":"#/components/schemas/phoneNumber"},"postalCode":{"type":"string","description":"Postal code"},"region":{"type":"string","description":"Region"},"remoteRoutingAddress":{"type":"string","description":"Address of associated mailbox"},"spamAndVirusConfiguration":{"description":"Antispam and Antivirus configuration","$ref":"#/components/schemas/email.exchange.spamAndVirusConfiguration"},"streetAddress":{"type":"string","description":"Street address"},"type":{"description":"Type of mailbox","$ref":"#/components/schemas/email.exchange.ExchangeRemoteMailboxTypeEnum"}},"required":["domain","exchangeGuid","login","password","remoteRoutingAddress","type"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@30"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: email.exchange.ExchangeRemoteMailboxTypeEnum\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox\",\n\tcity = None, # City (type: string, nullable)\n\tcompany = None, # Company name (type: string, nullable)\n\tcountryCode = None, # Country code (type: email.exchange.CountryCodeEnum, nullable)\n\tdescription = None, # Description (type: string, nullable)\n\tdisplayName = None, # Display name (type: string, nullable)\n\tdomain = None, # Email domain (type: string)\n\texchangeGuid = None, # Remote exchangeGuid (type: string)\n\tfax = None, # Fax number (type: phoneNumber, nullable)\n\tfirstName = None, # First name (type: string, nullable)\n\thiddenFromGAL = None, # Hide the remote mailbox in Global Address List (type: boolean, nullable)\n\tinitials = None, # Initials (type: string, nullable)\n\tjobDepartment = None, # Job department (type: string, nullable)\n\tjobTitle = None, # Job title (type: string, nullable)\n\tlastName = None, # Last name (type: string, nullable)\n\tlogin = None, # Login (type: string)\n\tmobile = None, # Mobile phone number (type: phoneNumber, nullable)\n\toffice = None, # Office (type: string, nullable)\n\tpassword = None, # Password (type: password)\n\tphone = None, # Phone Number (type: phoneNumber, nullable)\n\tpostalCode = None, # Postal code (type: string, nullable)\n\tregion = None, # Region (type: string, nullable)\n\tremoteRoutingAddress = None, # Address of associated mailbox (type: string)\n\tspamAndVirusConfiguration = None, # Antispam and Antivirus configuration (type: email.exchange.spamAndVirusConfiguration, nullable)\n\tstreetAddress = None, # Street address (type: string, nullable)\n\ttype = None, # Type of mailbox (type: email.exchange.ExchangeRemoteMailboxTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: email.exchange.ExchangeRemoteMailboxTypeEnum\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox\", array(\n\tcity => null, // City (type: string, nullable)\n\tcompany => null, // Company name (type: string, nullable)\n\tcountryCode => null, // Country code (type: email.exchange.CountryCodeEnum, nullable)\n\tdescription => null, // Description (type: string, nullable)\n\tdisplayName => null, // Display name (type: string, nullable)\n\tdomain => null, // Email domain (type: string)\n\texchangeGuid => null, // Remote exchangeGuid (type: string)\n\tfax => null, // Fax number (type: phoneNumber, nullable)\n\tfirstName => null, // First name (type: string, nullable)\n\thiddenFromGAL => null, // Hide the remote mailbox in Global Address List (type: boolean, nullable)\n\tinitials => null, // Initials (type: string, nullable)\n\tjobDepartment => null, // Job department (type: string, nullable)\n\tjobTitle => null, // Job title (type: string, nullable)\n\tlastName => null, // Last name (type: string, nullable)\n\tlogin => null, // Login (type: string)\n\tmobile => null, // Mobile phone number (type: phoneNumber, nullable)\n\toffice => null, // Office (type: string, nullable)\n\tpassword => null, // Password (type: password)\n\tphone => null, // Phone Number (type: phoneNumber, nullable)\n\tpostalCode => null, // Postal code (type: string, nullable)\n\tregion => null, // Region (type: string, nullable)\n\tremoteRoutingAddress => null, // Address of associated mailbox (type: string)\n\tspamAndVirusConfiguration => null, // Antispam and Antivirus configuration (type: email.exchange.spamAndVirusConfiguration, nullable)\n\tstreetAddress => null, // Street address (type: string, nullable)\n\ttype => null, // Type of mailbox (type: email.exchange.ExchangeRemoteMailboxTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/create","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}":{"delete":{"summary":"Delete a remote mailbox","description":"Delete a remote mailbox. Removes the remote mailbox from the Exchange service and returns the task. Its aliases are removed with it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@40"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/delete","required":true}]},"get":{"summary":"Get a remote mailbox","description":"Get a remote mailbox. Returns the login, names, type, remote routing address, state, spam settings and contact details of the remote mailbox.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.exchangeRemoteMailbox"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@20"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/get","required":true}]},"put":{"summary":"Update a remote mailbox","description":"Update a remote mailbox. Updates the names, display name, spam settings, Global Address List visibility and contact details of the remote mailbox.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.exchangeRemoteMailbox"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@50"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: email.exchange.exchangeRemoteMailbox\nresult = client.put(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}\",\n\tcity = None, # city (type: string, nullable)\n\tcompany = None, # Company name (type: string, nullable)\n\tcountryCode = None, # Country code (type: email.exchange.CountryCodeEnum, nullable)\n\tdescription = None, # Description (type: string, nullable)\n\tdisplayName = None, # Remote mailbox display name (type: string, nullable)\n\tdomain = None, # Remote mailbox domain (type: string)\n\tfax = None, # Fax number (type: phoneNumber, nullable)\n\tfirstName = None, # Remote mailbox first name (type: string, nullable)\n\thiddenFromGAL = None, # Hide remote mailbox  in Global Address List (type: boolean)\n\tinitial = None, # Remote mailbox initials (type: string, nullable)\n\tjobDepartment = None, # Job Department (type: string, nullable)\n\tjobTitle = None, # Job title (type: string, nullable)\n\tlastName = None, # Remote mailbox last name (type: string, nullable)\n\tlogin = None, # Remote mailbox login (type: string)\n\tmobile = None, # Mobile phone (type: phoneNumber, nullable)\n\toffice = None, # Job office (type: string, nullable)\n\tphone = None, # Phone number (type: phoneNumber, nullable)\n\tpostalCode = None, # Postal code (type: string, nullable)\n\tregion = None, # region (type: string, nullable)\n\tspamAndVirusConfiguration = None, # Spam and Antivirus configuration (type: email.exchange.spamAndVirusConfiguration)\n\tstreetAddress = None, # Street address (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: email.exchange.exchangeRemoteMailbox\n$result = $ovh->put(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}\", array(\n\tcity => null, // city (type: string, nullable)\n\tcompany => null, // Company name (type: string, nullable)\n\tcountryCode => null, // Country code (type: email.exchange.CountryCodeEnum, nullable)\n\tdescription => null, // Description (type: string, nullable)\n\tdisplayName => null, // Remote mailbox display name (type: string, nullable)\n\tdomain => null, // Remote mailbox domain (type: string)\n\tfax => null, // Fax number (type: phoneNumber, nullable)\n\tfirstName => null, // Remote mailbox first name (type: string, nullable)\n\thiddenFromGAL => null, // Hide remote mailbox  in Global Address List (type: boolean)\n\tinitial => null, // Remote mailbox initials (type: string, nullable)\n\tjobDepartment => null, // Job Department (type: string, nullable)\n\tjobTitle => null, // Job title (type: string, nullable)\n\tlastName => null, // Remote mailbox last name (type: string, nullable)\n\tlogin => null, // Remote mailbox login (type: string)\n\tmobile => null, // Mobile phone (type: phoneNumber, nullable)\n\toffice => null, // Job office (type: string, nullable)\n\tphone => null, // Phone number (type: phoneNumber, nullable)\n\tpostalCode => null, // Postal code (type: string, nullable)\n\tregion => null, // region (type: string, nullable)\n\tspamAndVirusConfiguration => null, // Spam and Antivirus configuration (type: email.exchange.spamAndVirusConfiguration)\n\tstreetAddress => null, // Street address (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/edit","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias":{"get":{"summary":"List remote mailbox aliases","description":"List remote mailbox aliases. Returns the aliases of the remote mailbox: extra addresses that deliver to the same mailbox.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@60"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/alias/get","required":true}],"x-expanded-response":"EmailExchangeExchangeRemoteMailboxAlias"},"post":{"summary":"Create a remote mailbox alias","description":"Create a remote mailbox alias. Adds the `alias` address to the remote mailbox, so that it receives its emails, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"type":"string","description":"Alias"}},"required":["alias"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@80"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias\",\n\talias = None, # Alias (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias\", array(\n\talias => null, // Alias (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/alias/create","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}":{"delete":{"summary":"Delete a remote mailbox alias","description":"Delete a remote mailbox alias. Removes the alias address from the remote mailbox, which no longer receives its emails, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"alias","description":"Alias","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@90"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/alias/delete","required":true}]},"get":{"summary":"Get a remote mailbox alias","description":"Get a remote mailbox alias. Returns the alias address, its creation date and the ID of its pending task, if any (`taskPendingId`).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"alias","description":"Alias","required":true,"schema":{"type":"string"}},{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.exchangeRemoteMailboxAlias"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@70"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/alias/{alias}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/alias/get","required":true}]}},"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/changePassword":{"post":{"summary":"Change a remote mailbox password","description":"Change a remote mailbox password. Changes the password and returns the task. Set `forcePasswordChangeAtNextLogon` to make the user change it at the next logon.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"exchangeService","description":"The internal name of your exchange service","required":true,"schema":{"type":"string"}},{"in":"path","name":"organizationName","description":"The internal name of your exchange organization","required":true,"schema":{"type":"string"}},{"in":"path","name":"primaryEmailAddress","description":"Default email for this mailbox","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"forcePasswordChangeAtNextLogon":{"type":"boolean","description":"The password will need to be changed at the next time you log on"},"password":{"type":"string","description":"New password","format":"password"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email.exchange.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Private Exchange","Remote Mailboxes@@@100"],["Web Cloud","Email and Collaborative Solutions","Microsoft Exchange","Trusted Exchange","Remote Mailboxes@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/changePassword\",\n\tforcePasswordChangeAtNextLogon = None, # The password will need to be changed at the next time you log on (type: boolean, nullable)\n\tpassword = None, # New password (type: password, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/email/exchange/{organizationName}/service/{exchangeService}/remoteMailbox/{primaryEmailAddress}/changePassword\", array(\n\tforcePasswordChangeAtNextLogon => null, // The password will need to be changed at the next time you log on (type: boolean, nullable)\n\tpassword => null, // New password (type: password, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"emailExchange:apiovh:service/remoteMailbox/changePassword","required":true}]}}}}
