{"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 !"},"auth.Certificate":{"type":"object","description":"X509 Certificate","properties":{"expiration":{"type":"string","description":"Certificate's expiration","format":"date-time","readOnly":true},"subject":{"type":"string","description":"Certificate's subject","readOnly":true}}},"auth.Provider":{"type":"object","description":"An IAM Federation Provider","properties":{"creation":{"type":"string","description":"Creation date of the identity provider","format":"date-time","readOnly":true},"disableUsers":{"type":"boolean","description":"Whether account users should still be usable as a login method or not","nullable":true},"extensions":{"allOf":[{"$ref":"#/components/schemas/auth.ProviderExtensions"}],"description":"SAML Extensions to embed inside the SAML requests"},"groupAttributeName":{"type":"string","description":"SAML Group attribute name"},"idpSigningCertificates":{"type":"array","description":"IdP's signing certificate","items":{"$ref":"#/components/schemas/auth.Certificate"},"readOnly":true},"lastUpdate":{"type":"string","description":"Last update of the identity provider","format":"date-time","readOnly":true},"signRequests":{"type":"boolean","description":"Whether SAML Authn Requests should be signed","nullable":true},"ssoServiceUrl":{"type":"string","description":"IdP's Single Sign On Service Url","readOnly":true},"userAttributeName":{"type":"string","description":"SAML User attribute name"}}},"auth.ProviderExtensions":{"type":"object","description":"A SAML 2.0 Extension that should be added to SAML requests when using this provider","properties":{"requestedAttributes":{"type":"array","description":"List of SAML RequestedAttribute to add to SAML requests","nullable":true,"items":{"$ref":"#/components/schemas/auth.ProviderRequestedAttributes"}}}},"auth.ProviderRequest":{"type":"object","description":"An IAM Federation Provider creation request","properties":{"disableUsers":{"type":"boolean","description":"Whether account users should still be usable as a login method or not","nullable":true},"extensions":{"allOf":[{"$ref":"#/components/schemas/auth.ProviderExtensions"}],"description":"SAML Extensions to embed inside the SAML requests"},"groupAttributeName":{"type":"string","description":"SAML Group attribute name","nullable":true},"metadata":{"type":"string","description":"IdP's signing certificate"},"signRequests":{"type":"boolean","description":"Whether SAML Authn Requests should be signed","nullable":true},"userAttributeName":{"type":"string","description":"SAML User attribute name","nullable":true}},"required":["metadata"]},"auth.ProviderRequestedAttributes":{"type":"object","description":"A SAML 2.0 requested attribute that should be added to SAML requests when using this provider","properties":{"isRequired":{"type":"boolean","description":"Expresses that this RequestedAttribute is mandatory (remains advisory)"},"name":{"type":"string","description":"Name of the SAML RequestedAttribute"},"nameFormat":{"type":"string","description":"NameFormat of the SAML RequestedAttribute","nullable":true},"values":{"type":"array","description":"List of AttributeValues allowed for this RequestedAttribute","nullable":true,"items":{"type":"string"}}},"required":["isRequired","name"]},"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"},"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":{"/me/identity/provider":{"delete":{"summary":"Remove the identity provider","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Identities","SSO"]],"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(\"/me/identity/provider\")\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(\"/me/identity/provider\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/identity/provider/delete","required":true}]},"get":{"summary":"Get the identity provider linked to this account","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth.Provider"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Identities","SSO"]],"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(\"/me/identity/provider\")\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(\"/me/identity/provider\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/identity/provider/get","required":true}]},"post":{"summary":"Define an identity provider (SAML 2.0)","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth.ProviderRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth.Provider"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Identities","SSO"]],"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: auth.ProviderRequest\nresult = client.post(\"/me/identity/provider\",\n\tdisableUsers = None, # Whether account users should still be usable as a login method or not (type: boolean, nullable)\n\textensions = None, # SAML Extensions to embed inside the SAML requests (type: auth.ProviderExtensions)\n\tgroupAttributeName = None, # SAML Group attribute name (type: string, nullable)\n\tmetadata = None, # IdP's signing certificate (type: string)\n\tsignRequests = None, # Whether SAML Authn Requests should be signed (type: boolean, nullable)\n\tuserAttributeName = None, # SAML User attribute name (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: auth.ProviderRequest\n$result = $ovh->post(\"/me/identity/provider\", array(\n\tdisableUsers => null, // Whether account users should still be usable as a login method or not (type: boolean, nullable)\n\textensions => null, // SAML Extensions to embed inside the SAML requests (type: auth.ProviderExtensions)\n\tgroupAttributeName => null, // SAML Group attribute name (type: string, nullable)\n\tmetadata => null, // IdP's signing certificate (type: string)\n\tsignRequests => null, // Whether SAML Authn Requests should be signed (type: boolean, nullable)\n\tuserAttributeName => null, // SAML User attribute name (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/identity/provider/create","required":true}]},"put":{"summary":"Alter the provider","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth.Provider"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Identities","SSO"]],"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: auth.Provider\nresult = client.put(\"/me/identity/provider\",\n\tdisableUsers = None, # Whether account users should still be usable as a login method or not (type: boolean, nullable)\n\textensions = None, # SAML Extensions to embed inside the SAML requests (type: auth.ProviderExtensions)\n\tgroupAttributeName = None, # SAML Group attribute name (type: string)\n\tsignRequests = None, # Whether SAML Authn Requests should be signed (type: boolean, nullable)\n\tuserAttributeName = None, # SAML User attribute 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: auth.Provider\n$result = $ovh->put(\"/me/identity/provider\", array(\n\tdisableUsers => null, // Whether account users should still be usable as a login method or not (type: boolean, nullable)\n\textensions => null, // SAML Extensions to embed inside the SAML requests (type: auth.ProviderExtensions)\n\tgroupAttributeName => null, // SAML Group attribute name (type: string)\n\tsignRequests => null, // Whether SAML Authn Requests should be signed (type: boolean, nullable)\n\tuserAttributeName => null, // SAML User attribute name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/identity/provider/edit","required":true}]}}}}