{"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"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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"},"license.office.OfficeTenant":{"type":"object","description":"Office tenant","properties":{"address":{"type":"string","description":"Contact's address line"},"city":{"type":"string","description":"Contact's city"},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Tenant's display name"},"firstName":{"type":"string","description":"Contact's fisrt name"},"lastName":{"type":"string","description":"Contact's fisrt name"},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Primary phone number"},"serviceName":{"type":"string","description":"Internal service name","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceTypeEnum"}],"description":"Tenant's service type","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceStateEnum"}],"readOnly":true},"zipCode":{"type":"string","description":"Contact's zip code"}}},"license.office.OfficeTenantNative":{"type":"object","description":"Office tenant","properties":{"address":{"type":"string","description":"Contact's address line"},"city":{"type":"string","description":"Contact's city"},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Tenant's display name"},"firstName":{"type":"string","description":"Contact's first name"},"lastName":{"type":"string","description":"Contact's last name"},"mcaAgreed":{"type":"boolean","description":"MCA acceptance status"},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Primary phone number"},"serviceName":{"type":"string","description":"Internal service name","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceTypeEnum"}],"description":"Tenant's service type","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceStateEnum"}],"description":"Tenant's status","readOnly":true},"zipCode":{"type":"string","description":"Contact's zip code"}}},"license.office.OfficeTenantNativeWithIAM":{"type":"object","description":"Office tenant","properties":{"address":{"type":"string","description":"Contact's address line"},"city":{"type":"string","description":"Contact's city"},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Tenant's display name"},"firstName":{"type":"string","description":"Contact's first name"},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"lastName":{"type":"string","description":"Contact's last name"},"mcaAgreed":{"type":"boolean","description":"MCA acceptance status"},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Primary phone number"},"serviceName":{"type":"string","description":"Internal service name","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceTypeEnum"}],"description":"Tenant's service type","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceStateEnum"}],"description":"Tenant's status","readOnly":true},"zipCode":{"type":"string","description":"Contact's zip code"}}},"license.office.OfficeTenantWithIAM":{"type":"object","description":"Office tenant","properties":{"address":{"type":"string","description":"Contact's address line"},"city":{"type":"string","description":"Contact's city"},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Tenant's display name"},"firstName":{"type":"string","description":"Contact's fisrt name"},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"lastName":{"type":"string","description":"Contact's fisrt name"},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Primary phone number"},"serviceName":{"type":"string","description":"Internal service name","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceTypeEnum"}],"description":"Tenant's service type","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/license.office.ServiceStateEnum"}],"readOnly":true},"zipCode":{"type":"string","description":"Contact's zip code"}}},"license.office.ServiceStateEnum":{"type":"string","description":"Office tenant state","enum":["creating","inMaintenance","ok","suspended"]},"license.office.ServiceTypeEnum":{"type":"string","description":"Type of service","enum":["payAsYouGo","prepaid"]},"license.officePrepaid.OfficeTenantNative":{"type":"object","description":"Office tenant","properties":{"address":{"type":"string","description":"Contact's address line","readOnly":true},"city":{"type":"string","description":"Contact's city","readOnly":true},"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Tenant's display name","readOnly":true},"firstName":{"type":"string","description":"Contact's first name","readOnly":true},"lastName":{"type":"string","description":"Contact's last name","readOnly":true},"mcaAgreed":{"type":"boolean","description":"MCA acceptance status","readOnly":true},"phone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Primary phone number","readOnly":true},"serviceName":{"type":"string","description":"Tenant's service name","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/license.officePrepaid.ServiceTypeEnum"}],"description":"Tenant's service type","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/license.officePrepaid.ServiceStateEnum"}],"description":"Tenant's status","readOnly":true},"zipCode":{"type":"string","description":"Contact's zip code","readOnly":true}}},"license.officePrepaid.OfficeTenantPutParentTenant":{"type":"object","description":"Office tenant","properties":{"displayName":{"type":"string","description":"Parent tenant display name"},"serviceName":{"type":"string","description":"Parent tenant name","readOnly":true}}},"license.officePrepaid.ServiceStateEnum":{"type":"string","description":"Office tenant state","enum":["creating","inMaintenance","ok","reopening","suspended","suspending"]},"license.officePrepaid.ServiceTypeEnum":{"type":"string","description":"Office tenant type","enum":["payAsYouGo","prepaid"]},"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"},"service.RenewType":{"type":"object","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","description":"The service is automatically renewed"},"deleteAtExpiration":{"type":"boolean","description":"The service will be deleted at expiration"},"forced":{"type":"boolean","description":"The service forced to be renewed"},"manualPayment":{"type":"boolean","description":"The service needs to be manually renewed and paid","nullable":true},"period":{"type":"integer","description":"period of renew in month","nullable":true}}},"service.RenewalTypeEnum":{"type":"string","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","automaticV2024","manual","oneShot","option"]},"service.StateEnum":{"type":"string","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"services.Service":{"type":"object","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","description":"Indicates that the service can be set up to be deleted at expiration","readOnly":true},"contactAdmin":{"type":"string","readOnly":true},"contactBilling":{"type":"string","readOnly":true},"contactTech":{"type":"string","readOnly":true},"creation":{"type":"string","format":"date","readOnly":true},"domain":{"type":"string","readOnly":true},"engagedUpTo":{"type":"string","nullable":true,"format":"date","readOnly":true},"expiration":{"type":"string","format":"date","readOnly":true},"possibleRenewPeriod":{"type":"array","description":"All the possible renew period of your service in month","nullable":true,"items":{"type":"integer"},"readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/service.RenewType"}],"description":"Way of handling the renew","nullable":true},"renewalType":{"allOf":[{"$ref":"#/components/schemas/service.RenewalTypeEnum"}],"readOnly":true},"serviceId":{"type":"integer","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/service.StateEnum"}],"readOnly":true}}},"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":{"/license/office":{"get":{"summary":"List tenants","description":"Returns the service names of the tenants.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"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 365","General Information@@@10"]],"x-badges":[{"color":"blue","label":"Alpha 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(\"/license/office\")\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(\"/license/office\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOffice:apiovh:get","required":true}],"x-expanded-response":"LicenseOfficeOfficeTenantNativeWithIAM"}},"/license/office/{serviceName}":{"get":{"summary":"Get a tenant","description":"Returns the display name, contact details, service type, status and creation date of the tenant, and whether the Microsoft Customer Agreement (MCA) is accepted.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/license.office.OfficeTenantNativeWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","General Information@@@20"]],"x-badges":[{"color":"blue","label":"Alpha 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(\"/license/office/{serviceName}\")\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(\"/license/office/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOffice:apiovh:get","required":true}]},"put":{"summary":"Update a tenant","description":"Updates the display name and the contact details of the tenant: first name, last name, address, zip code, city and phone number.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/license.office.OfficeTenantNative"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","General Information@@@30"]],"x-badges":[{"color":"blue","label":"Alpha 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: license.office.OfficeTenantNative\nresult = client.put(\"/license/office/{serviceName}\",\n\taddress = None, # Contact's address line (type: string)\n\tcity = None, # Contact's city (type: string)\n\tdisplayName = None, # Tenant's display name (type: string)\n\tfirstName = None, # Contact's first name (type: string)\n\tlastName = None, # Contact's last name (type: string)\n\tmcaAgreed = None, # MCA acceptance status (type: boolean)\n\tphone = None, # Primary phone number (type: phoneNumber)\n\tzipCode = None, # Contact's zip code (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: license.office.OfficeTenantNative\n$result = $ovh->put(\"/license/office/{serviceName}\", array(\n\taddress => null, // Contact's address line (type: string)\n\tcity => null, // Contact's city (type: string)\n\tdisplayName => null, // Tenant's display name (type: string)\n\tfirstName => null, // Contact's first name (type: string)\n\tlastName => null, // Contact's last name (type: string)\n\tmcaAgreed => null, // MCA acceptance status (type: boolean)\n\tphone => null, // Primary phone number (type: phoneNumber)\n\tzipCode => null, // Contact's zip code (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOffice:apiovh:edit","required":true}]}},"/license/office/{serviceName}/serviceInfos":{"get":{"summary":"Get service information","description":"Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The unique identifier of your Office service","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","General Information@@@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.get(\"/license/office/{serviceName}/serviceInfos\")\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(\"/license/office/{serviceName}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOffice:apiovh:serviceInfos/get","required":true}]},"put":{"summary":"Update service information","description":"Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The unique identifier of your Office service","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","General Information@@@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: services.Service\nresult = client.put(\"/license/office/{serviceName}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, 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: services.Service\n$result = $ovh->put(\"/license/office/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOffice:apiovh:serviceInfos/edit","required":true}]}},"/license/officePrepaid/{serviceName}/parentTenant":{"get":{"summary":"Get the parent tenant","description":"Returns the tenant of the prepaid user: display name, contact details, service type, status, and whether the Microsoft Customer Agreement (MCA) is accepted.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/license.officePrepaid.OfficeTenantNative"}}}}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","General Information@@@60"]],"x-badges":[{"color":"blue","label":"Alpha 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(\"/license/officePrepaid/{serviceName}/parentTenant\")\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(\"/license/officePrepaid/{serviceName}/parentTenant\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOfficePrepaid:apiovh:parentTenant/get","required":true}]},"put":{"summary":"Update the parent tenant","description":"Updates the display name of the tenant of the prepaid user.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/license.officePrepaid.OfficeTenantPutParentTenant"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Email and Collaborative Solutions","Microsoft 365","General Information@@@70"]],"x-badges":[{"color":"blue","label":"Alpha 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: license.officePrepaid.OfficeTenantPutParentTenant\nresult = client.put(\"/license/officePrepaid/{serviceName}/parentTenant\",\n\tdisplayName = None, # Parent tenant display name (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: license.officePrepaid.OfficeTenantPutParentTenant\n$result = $ovh->put(\"/license/officePrepaid/{serviceName}/parentTenant\", array(\n\tdisplayName => null, // Parent tenant display name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"licenseOfficePrepaid:apiovh:parentTenant/edit","required":true}]}}}}