---
title: "Authenticate against the Data Platform IAM API"
description: "This page contains the API reference for the Identity Access Manager (IAM)"
url: https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/developers-api-authentication
lang: pt
lastUpdated: 2026-09-14
---
> For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/pt/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/pt/llms-full.txt.

# Authenticate against the Data Platform IAM API

## Objective

This page contains the API reference for the [Identity Access Manager (IAM)](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/landing-page-iam.md). IAM APIs will always look like this:

```text
https://{project_url}/iam
```

## Login endpoint

### Using a login/password method

This authentication mode allows you to [connect with a login and password](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/iam-auth-providers.md#project) defined in your [Identity Access Manager](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/landing-page-iam.md).

:::info
In the base URLs in the code snippets below, you will need to replace `my-project` with your [Project's subdomain](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/manage-projects-config-variables.md#project-subdomain).
:::

Example request :

```bash
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 :

```json
{
"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"
}
```

| Name       |  Type  |                                                                               Description |
| :--------- | :----: | ----------------------------------------------------------------------------------------: |
| login      | String |                             The login of the user, as received in the registration email. |
| password   | String |                          The password of the user, as received in the registration email. |
| app\_id    | String |   The application identifier (set to 'forepaas' to login to the project's IAM in general) |
| auth\_mode | String | The 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](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/tutorials-generate-api-keys.md) defined in your [Identity Access Manager](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/landing-page-iam.md).

:::info
In the base URLs in the code snippets below, you will need to replace `my-project` with your [Project's subdomain](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/manage-projects-config-variables.md#project-subdomain).
:::

Example request:

```bash
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:

```json
{
"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"
}
```

| Name       |          Type         |                                                                             Description |
| :--------- | :-------------------: | --------------------------------------------------------------------------------------: |
| apikey     | String \[A-Za-z0- 9-] |                                    The api key provided by the new device registration. |
| secretkey  | String \[A-Za-z0- 9-] |                                 The secret key provided by the new device registration. |
| app\_id    |         String        | The application identifier (set to 'forepaas' to login to the project's IAM in general) |
| auth\_mode |         String        |                      The 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](https://docs.ovhcloud.com/pt/guides/public-cloud/data-platform/manage-projects-config-variables.md#project-subdomain).
:::

Example request:

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

:::

Example response:

```json
{
  "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](https://www.ovhcloud.com/pt/professional-services/) 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](https://discord.gg/ovhcloud).

If you need support with your OVHcloud services, create a request in our [Help Centre](https://help.ovhcloud.com/csm?id=csm_get_help).

Join our [community of users](https://community.ovhcloud.com/).