For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/legacy/api-reference-iam.md.
  • 🇬🇧 English

    • API Reference: Identity Access Manager

    Warning

    This page describes the ForePaaS Legacy Platform, which no longer accepts new signups. If you are using OVHcloud Data Platform, see the current IAM API reference.

    This page contains the API reference for the Identity Access Manager (IAM). IAM APIs will always look like this:

    https://`%dataplant_url%/iam

    Login endpoint

    Using a login/password method

    This authentication mode allows you to connect with a login and password defined in your Identity Access Manager.

    Example request :

    curl -X POST \
  https://mydataplant.eu.dataplatform.ovh.net/iam/login \
  -H 'Content-Type: application/json' \
  -d '{
	"login":"LOGIN",
	"password":"****",
	"app_id":"APPID",
	"auth_mode":"forepaas_id_resource_owner"
}'

    Example response :

    {
"uid": "John Doe", // The unique id of the logged-in user
"user": "M. John Doe", // The full name of the logged-in user
"firstname": "John", // The first name of the logged-in user
"lastname": "Doe", // The last name of the logged-in user
"civility": "M. ", // The civility of the logged-in user
"login": "john.doe", // The login of the logged-in user
"password_renew": false, // flag to know if the has to change his password "password_expiration": "2020-02-28T17:17:10.274Z ", // password expiration
date
"token": "f54e34a56b897"
}
    loginStringThe login of the user, as received in the registration email.
    passwordStringThe password of the user, as received in the registration email.
    app_idStringThe application identifier (set to 'forepaas' to login to the project's IAM in general)
    auth_modeStringThe authentication mode to used. The value must be set to “forepaas_id_resource_owner”

    API Key Credentials

    This authentication mode allows you to connect with an API and secret key defined in your Identity Access Manager.

    Example request:

    curl -X POST \
  https://mydataplant.eu.dataplatform.ovh.net/iam/login \
  -H 'Content-Type: application/json' \
  -d '{
	"apikey":"APIKEY",
	"secretkey":"****",
	"app_id":"APPID",
	"auth_mode":"apikey"
}'

    Example response:

    {
"uid": "John Doe", // The unique id of the logged-in user
"user": "M. John Doe", // The full name of the logged-in user
"firstname": "John", // The first name of the logged-in user
"lastname": "Doe", // The last name of the logged-in user
"civility": "M. ", // The civility of the logged-in user
"login": "john.doe", // The login of the logged-in user
"password_renew": false, // flag to know if the has to change his password "password_expiration": "2020-02-28T17:17:10.274Z ", // password expiration
date
"token": "f54e34a56b897"
}
    apikeyString [A-Za-z0- 9-]The api key provided by the new device registration.
    secretkeyString [A-Za-z0- 9-]The secret key provided by the new device registration.
    app_idStringThe application identifier (set to 'forepaas' to login to the project's IAM in general)
    auth_modeStringThe authentication mode to used. The value must be set to “apikey”

    Logout endpoint

    In order to delete a token, you can call the logout endpoint.

    Example request:

    curl -X DELETE \
  https://mydataplant.eu.dataplatform.ovh.net/iam/logout?app_id=*****&token=***** \
  -H 'Content-Type: application/json'

    Example response:

    {
  "success": true,
  "status": 200,
  "duration": 0.02
}