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/developers-api-authentication.md.
  • 🇬🇧 English

    • Authenticate against the Data Platform IAM API

    This page contains the API reference for the Identity Access Manager (IAM)

    Objective

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

    https://{project_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.

    Info

    In the base URLs in the code snippets below, you will need to replace my-project with your Project's subdomain.

    Example request :

    curl -X POST \
  https://my-project.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 user has to change their password
"password_expiration": "2020-02-28T17:17:10.274Z", // password expiration date
"token": "f54e34a56b897"
}
    NameTypeDescription
    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.

    Info

    In the base URLs in the code snippets below, you will need to replace my-project with your Project's subdomain.

    Example request:

    curl -X POST \
  https://my-project.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 user has to change their password
"password_expiration": "2020-02-28T17:17:10.274Z", // password expiration date
"token": "f54e34a56b897"
}
    NameTypeDescription
    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.

    Info

    In the base URLs in the code snippets below, you will need to replace my-project with your Project's subdomain.

    Example request:

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

    :::

    Example response:

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

    Go further

    If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

    Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

    If you need support with your OVHcloud services, create a request in our Help Centre.

    Join our community of users.