# Public Cloud › Analytics › Lakehouse › Users API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Public Cloud product's sections: https://developers.eu.ovhcloud.com/reference/public-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 15 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/

OpenAPI v1: https://api.eu.ovhcloud.com/v1/__schemas/developer-hub-navigation/public-cloud/analytics/lakehouse/users.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/public-cloud/analytics/lakehouse/users.json?format=openapi3

## Operations

- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user` — List the users of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}` — Get a user of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user` — Create a user in your lakehouse
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}` — Delete a user of your lakehouse
- `PUT /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}` — Update a user of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential` — List the credentials of a user of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential` — Create a credential for a user of your lakehouse and get its secrets
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}` — Get a credential of a user of your lakehouse
- `DELETE /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}` — Delete a revoked or expired credential of a user of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}/revoke` — Revoke a credential of a user of your lakehouse
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/reset` — Deprecated: reset the credentials of a user of your lakehouse and get a new one
- `POST /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/revoke` — Revoke every active credential of a user of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/event` — List the events of a user of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task` — List the tasks of a user of your lakehouse
- `GET /publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task/{taskId}` — Get a task of a user of your lakehouse

## List the users of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getAllLakehouseUsers

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.User[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between. |
| `createdAt` | string (date-time) | read-only | Date the user was created |
| `currentState` | publicCloud.lakehouse.UserCurrentState | read-only | Current state of the user, computed by the service |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the user. Null until the user is first READY. |
| `currentState.credentials` | publicCloud.lakehouse.UserCredentialsSummary | read-only | Summary of the credentials of the user |
| `currentState.credentials.activeCount` | integer | read-only | Number of ACTIVE credentials of the user |
| `currentState.credentials.earliestExpiresAt` | string (date-time) | read-only | Earliest expiry date among the ACTIVE credentials of the user. Null when the user has no ACTIVE credential. |
| `currentState.credentialsResetAt` | string (date-time) | read-only | Date of the last credentials reset. Null until the first reset. |
| `currentState.description` | string | read-only | Description of the user. Null when it has none. |
| `currentState.name` | string | read-only | Name of the user |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the user is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `CANCELED`, `CATALOG_NOT_EMPTY`, `DEDICATED_COMPUTE_POOL_EXISTS`, `DEDICATED_UNAVAILABLE`, `INVALID_SHAPE`, `LAKEHOUSE_NOT_EMPTY`, `OPERATION_FAILED`, `QUOTA_EXCEEDED`, `RECONCILE_FAILED`, `REGION_UNAVAILABLE`, `SCHEMA_NOT_EMPTY`, `TIMED_OUT` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.type` | publicCloud.lakehouse.UserTypeEnum | read-only | Whether the identity is a person or a service account — one of `SERVICE_ACCOUNT`, `USER` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the user, and its last failed task while the user is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the user |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the user. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a `*_NOT_EMPTY` status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.UserTargetSpec | read-only | Last requested specification of the user |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the user, unique in the lakehouse. Same rules as the lakehouse name. Immutable after creation. |
| `targetSpec.type` | publicCloud.lakehouse.UserTypeEnum | yes | Whether the identity is a person or a service account. Immutable after creation. — one of `SERVICE_ACCOUNT`, `USER` |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the user |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "currentState": {
      "clientId": "string",
      "credentials": {
        "activeCount": 0,
        "earliestExpiresAt": "2024-01-01T12:00:00Z"
      },
      "credentialsResetAt": "2024-01-01T12:00:00Z",
      "description": "string",
      "name": "string",
      "statusReason": {
        "code": "CANCELED",
        "message": "string"
      },
      "type": "SERVICE_ACCOUNT"
    },
    "currentTasks": [
      {
        "errors": [
          {
            "message": "string"
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "link": "string",
        "status": "ERROR",
        "type": "string"
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "resourceStatus": "CREATING",
    "targetSpec": {
      "description": "string",
      "name": "string",
      "type": "SERVICE_ACCOUNT"
    },
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user");

print_r($result);
?>
```

## Get a user of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getLakehouseUser

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.User | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between. |
| `createdAt` | string (date-time) | read-only | Date the user was created |
| `currentState` | publicCloud.lakehouse.UserCurrentState | read-only | Current state of the user, computed by the service |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the user. Null until the user is first READY. |
| `currentState.credentials` | publicCloud.lakehouse.UserCredentialsSummary | read-only | Summary of the credentials of the user |
| `currentState.credentials.activeCount` | integer | read-only | Number of ACTIVE credentials of the user |
| `currentState.credentials.earliestExpiresAt` | string (date-time) | read-only | Earliest expiry date among the ACTIVE credentials of the user. Null when the user has no ACTIVE credential. |
| `currentState.credentialsResetAt` | string (date-time) | read-only | Date of the last credentials reset. Null until the first reset. |
| `currentState.description` | string | read-only | Description of the user. Null when it has none. |
| `currentState.name` | string | read-only | Name of the user |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the user is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `CANCELED`, `CATALOG_NOT_EMPTY`, `DEDICATED_COMPUTE_POOL_EXISTS`, `DEDICATED_UNAVAILABLE`, `INVALID_SHAPE`, `LAKEHOUSE_NOT_EMPTY`, `OPERATION_FAILED`, `QUOTA_EXCEEDED`, `RECONCILE_FAILED`, `REGION_UNAVAILABLE`, `SCHEMA_NOT_EMPTY`, `TIMED_OUT` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.type` | publicCloud.lakehouse.UserTypeEnum | read-only | Whether the identity is a person or a service account — one of `SERVICE_ACCOUNT`, `USER` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the user, and its last failed task while the user is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the user |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the user. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a `*_NOT_EMPTY` status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.UserTargetSpec | read-only | Last requested specification of the user |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the user, unique in the lakehouse. Same rules as the lakehouse name. Immutable after creation. |
| `targetSpec.type` | publicCloud.lakehouse.UserTypeEnum | yes | Whether the identity is a person or a service account. Immutable after creation. — one of `SERVICE_ACCOUNT`, `USER` |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the user |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "clientId": "string",
    "credentials": {
      "activeCount": 0,
      "earliestExpiresAt": "2024-01-01T12:00:00Z"
    },
    "credentialsResetAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "name": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "type": "SERVICE_ACCOUNT"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "description": "string",
    "name": "string",
    "type": "SERVICE_ACCOUNT"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}");

print_r($result);
?>
```

## Create a user in your lakehouse

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#createLakehouseUser

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/create`

Creates the user asynchronously. The response is the user in CREATING, with the creation task in `currentTasks`: follow it on the task routes of the user, or read the user until its `resourceStatus` is READY or ERROR.

The creation is refused with a 409 while the lakehouse is being deleted. Once the user is READY, create a credential to get its client secret, and an S3™* access key when you set `s3Access`.

<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |

### Request body (required)

Type: `publicCloud.lakehouse.UserCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetSpec` | publicCloud.lakehouse.UserTargetSpec | yes | Specification of the user to create |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the user, unique in the lakehouse. Same rules as the lakehouse name. Immutable after creation. |
| `targetSpec.type` | publicCloud.lakehouse.UserTypeEnum | yes | Whether the identity is a person or a service account. Immutable after creation. — one of `SERVICE_ACCOUNT`, `USER` |

```json
{
  "targetSpec": {
    "description": "string",
    "name": "string",
    "type": "SERVICE_ACCOUNT"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.User | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between. |
| `createdAt` | string (date-time) | read-only | Date the user was created |
| `currentState` | publicCloud.lakehouse.UserCurrentState | read-only | Current state of the user, computed by the service |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the user. Null until the user is first READY. |
| `currentState.credentials` | publicCloud.lakehouse.UserCredentialsSummary | read-only | Summary of the credentials of the user |
| `currentState.credentials.activeCount` | integer | read-only | Number of ACTIVE credentials of the user |
| `currentState.credentials.earliestExpiresAt` | string (date-time) | read-only | Earliest expiry date among the ACTIVE credentials of the user. Null when the user has no ACTIVE credential. |
| `currentState.credentialsResetAt` | string (date-time) | read-only | Date of the last credentials reset. Null until the first reset. |
| `currentState.description` | string | read-only | Description of the user. Null when it has none. |
| `currentState.name` | string | read-only | Name of the user |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the user is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `CANCELED`, `CATALOG_NOT_EMPTY`, `DEDICATED_COMPUTE_POOL_EXISTS`, `DEDICATED_UNAVAILABLE`, `INVALID_SHAPE`, `LAKEHOUSE_NOT_EMPTY`, `OPERATION_FAILED`, `QUOTA_EXCEEDED`, `RECONCILE_FAILED`, `REGION_UNAVAILABLE`, `SCHEMA_NOT_EMPTY`, `TIMED_OUT` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.type` | publicCloud.lakehouse.UserTypeEnum | read-only | Whether the identity is a person or a service account — one of `SERVICE_ACCOUNT`, `USER` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the user, and its last failed task while the user is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the user |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the user. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a `*_NOT_EMPTY` status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.UserTargetSpec | read-only | Last requested specification of the user |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the user, unique in the lakehouse. Same rules as the lakehouse name. Immutable after creation. |
| `targetSpec.type` | publicCloud.lakehouse.UserTypeEnum | yes | Whether the identity is a person or a service account. Immutable after creation. — one of `SERVICE_ACCOUNT`, `USER` |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the user |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "clientId": "string",
    "credentials": {
      "activeCount": 0,
      "earliestExpiresAt": "2024-01-01T12:00:00Z"
    },
    "credentialsResetAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "name": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "type": "SERVICE_ACCOUNT"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "description": "string",
    "name": "string",
    "type": "SERVICE_ACCOUNT"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.lakehouse.UserCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user",
	targetSpec = None, # Specification of the user to create (type: publicCloud.lakehouse.UserTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.lakehouse.UserCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user", array(
	targetSpec => null, // Specification of the user to create (type: publicCloud.lakehouse.UserTargetSpec)
));

print_r($result);
?>
```

## Delete a user of your lakehouse

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#deleteLakehouseUser

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/delete`

Deletes the user asynchronously. The response is the user in DELETING, with the deletion task in `currentTasks`. Once the deletion completes, the user and every route under it, its tasks included, answer 404. Deleting a user also deletes its role assignments and its group memberships. The deletion is refused with a 409 when it would remove the last Lakehouse Admin assignment of the lakehouse: assign the Lakehouse Admin role to another identity first.

A deletion is accepted in READY and ERROR, and also in CREATING and UPDATING, where it replaces the change in progress. A new deletion while one is running is refused with a 409.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.User | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between. |
| `createdAt` | string (date-time) | read-only | Date the user was created |
| `currentState` | publicCloud.lakehouse.UserCurrentState | read-only | Current state of the user, computed by the service |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the user. Null until the user is first READY. |
| `currentState.credentials` | publicCloud.lakehouse.UserCredentialsSummary | read-only | Summary of the credentials of the user |
| `currentState.credentials.activeCount` | integer | read-only | Number of ACTIVE credentials of the user |
| `currentState.credentials.earliestExpiresAt` | string (date-time) | read-only | Earliest expiry date among the ACTIVE credentials of the user. Null when the user has no ACTIVE credential. |
| `currentState.credentialsResetAt` | string (date-time) | read-only | Date of the last credentials reset. Null until the first reset. |
| `currentState.description` | string | read-only | Description of the user. Null when it has none. |
| `currentState.name` | string | read-only | Name of the user |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the user is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `CANCELED`, `CATALOG_NOT_EMPTY`, `DEDICATED_COMPUTE_POOL_EXISTS`, `DEDICATED_UNAVAILABLE`, `INVALID_SHAPE`, `LAKEHOUSE_NOT_EMPTY`, `OPERATION_FAILED`, `QUOTA_EXCEEDED`, `RECONCILE_FAILED`, `REGION_UNAVAILABLE`, `SCHEMA_NOT_EMPTY`, `TIMED_OUT` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.type` | publicCloud.lakehouse.UserTypeEnum | read-only | Whether the identity is a person or a service account — one of `SERVICE_ACCOUNT`, `USER` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the user, and its last failed task while the user is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the user |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the user. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a `*_NOT_EMPTY` status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.UserTargetSpec | read-only | Last requested specification of the user |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the user, unique in the lakehouse. Same rules as the lakehouse name. Immutable after creation. |
| `targetSpec.type` | publicCloud.lakehouse.UserTypeEnum | yes | Whether the identity is a person or a service account. Immutable after creation. — one of `SERVICE_ACCOUNT`, `USER` |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the user |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "clientId": "string",
    "credentials": {
      "activeCount": 0,
      "earliestExpiresAt": "2024-01-01T12:00:00Z"
    },
    "credentialsResetAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "name": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "type": "SERVICE_ACCOUNT"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "description": "string",
    "name": "string",
    "type": "SERVICE_ACCOUNT"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}");

print_r($result);
?>
```

## Update a user of your lakehouse

`PUT /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#editLakehouseUser

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/edit`

Replaces the user's target specification as a whole. The body carries the complete desired state of every field `publicCloud.lakehouse.UserUpdateTargetSpec` exposes — `description` — so read the user first and restate every value you want to keep: a field left out of `targetSpec` is cleared, not carried over from the stored specification.

The create-only fields `name` and `type` cannot be changed once the user exists. They are deliberately absent from the update model, and sending one is rejected with a 400.

On a READY user the change is applied at once: the response is 200 with the user READY. On a user in ERROR the change is applied asynchronously, even when the specification is unchanged, to bring the user out of ERROR: the response is 202 with the user UPDATING and the new task in `currentTasks`. The update is refused with a 409 while the user is CREATING, UPDATING or DELETING, and after a refused deletion, from which only a new deletion is accepted.

The optional `checksum` guards against a lost update: when supplied it must match the user's current checksum or the request is rejected with a 409 checksum mismatch. Omitting it skips the check and forces the write (last-write-wins).

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Request body (required)

Type: `publicCloud.lakehouse.UserUpdate`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string |  | Checksum of the user as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the user changed since. When omitted or empty, no check is made. |
| `targetSpec` | publicCloud.lakehouse.UserUpdateTargetSpec | yes | New specification of the user. It replaces the whole current specification: an optional field you omit is reset to its default. Send only the fields of this model: a field that can only be set at creation is refused. |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |

```json
{
  "checksum": "string",
  "targetSpec": {
    "description": "string"
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.User | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between. |
| `createdAt` | string (date-time) | read-only | Date the user was created |
| `currentState` | publicCloud.lakehouse.UserCurrentState | read-only | Current state of the user, computed by the service |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the user. Null until the user is first READY. |
| `currentState.credentials` | publicCloud.lakehouse.UserCredentialsSummary | read-only | Summary of the credentials of the user |
| `currentState.credentials.activeCount` | integer | read-only | Number of ACTIVE credentials of the user |
| `currentState.credentials.earliestExpiresAt` | string (date-time) | read-only | Earliest expiry date among the ACTIVE credentials of the user. Null when the user has no ACTIVE credential. |
| `currentState.credentialsResetAt` | string (date-time) | read-only | Date of the last credentials reset. Null until the first reset. |
| `currentState.description` | string | read-only | Description of the user. Null when it has none. |
| `currentState.name` | string | read-only | Name of the user |
| `currentState.statusReason` | publicCloud.lakehouse.StatusReason | read-only | Why the user is in ERROR. Null in any other status. |
| `currentState.statusReason.code` | publicCloud.lakehouse.StatusReasonCodeEnum | read-only | Stable code of the reason, for programs — one of `CANCELED`, `CATALOG_NOT_EMPTY`, `DEDICATED_COMPUTE_POOL_EXISTS`, `DEDICATED_UNAVAILABLE`, `INVALID_SHAPE`, `LAKEHOUSE_NOT_EMPTY`, `OPERATION_FAILED`, `QUOTA_EXCEEDED`, `RECONCILE_FAILED`, `REGION_UNAVAILABLE`, `SCHEMA_NOT_EMPTY`, `TIMED_OUT` |
| `currentState.statusReason.message` | string | read-only | Explanation of the reason, for people. It may change. Do not parse it. |
| `currentState.type` | publicCloud.lakehouse.UserTypeEnum | read-only | Whether the identity is a person or a service account — one of `SERVICE_ACCOUNT`, `USER` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the user, and its last failed task while the user is in ERROR. Always an array. Empty when there is none. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the user |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the user. A change is accepted only in READY or ERROR, except after a refused deletion (ERROR with a `*_NOT_EMPTY` status reason code), where only a new deletion is accepted. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.UserTargetSpec | read-only | Last requested specification of the user |
| `targetSpec.description` | string |  | Description of the user. At most 255 characters. |
| `targetSpec.name` | string | yes | Name of the user, unique in the lakehouse. Same rules as the lakehouse name. Immutable after creation. |
| `targetSpec.type` | publicCloud.lakehouse.UserTypeEnum | yes | Whether the identity is a person or a service account. Immutable after creation. — one of `SERVICE_ACCOUNT`, `USER` |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the user |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "clientId": "string",
    "credentials": {
      "activeCount": 0,
      "earliestExpiresAt": "2024-01-01T12:00:00Z"
    },
    "credentialsResetAt": "2024-01-01T12:00:00Z",
    "description": "string",
    "name": "string",
    "statusReason": {
      "code": "CANCELED",
      "message": "string"
    },
    "type": "SERVICE_ACCOUNT"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "description": "string",
    "name": "string",
    "type": "SERVICE_ACCOUNT"
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X PUT \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.lakehouse.UserUpdate
result = client.put("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}",
	checksum = None, # Checksum of the user as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the user changed since. When omitted or empty, no check is made. (type: string, nullable)
	targetSpec = None, # New specification of the user. It replaces the whole current specification: an optional field you omit is reset to its default. Send only the fields of this model: a field that can only be set at creation is refused. (type: publicCloud.lakehouse.UserUpdateTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.lakehouse.UserUpdate
$result = $ovh->put("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}", array(
	checksum => null, // Checksum of the user as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the user changed since. When omitted or empty, no check is made. (type: string, nullable)
	targetSpec => null, // New specification of the user. It replaces the whole current specification: an optional field you omit is reset to its default. Send only the fields of this model: a field that can only be set at creation is refused. (type: publicCloud.lakehouse.UserUpdateTargetSpec)
));

print_r($result);
?>
```

## List the credentials of a user of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getAllLakehouseUserCredentials

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credential/get`

Returns the credentials of the user in every status, without their secrets. A REVOKED or EXPIRED credential stays listed for 30 days after its revocation or expiry, then is purged.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Credential[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the credential |
| `createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState` | publicCloud.lakehouse.CredentialCurrentState | read-only | Current state of the credential, computed by the service |
| `currentState.accessKey` | string | read-only | S3 access key of the credential. Null when the credential was created without S3 access, and for the credential named `initial` whose S3 key was issued before credentials existed. |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the credential |
| `currentState.createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState.expiresAt` | string (date-time) | read-only | Date the credential stops working |
| `currentState.name` | string | read-only | Name of the credential |
| `currentState.revokedAt` | string (date-time) | read-only | Date the credential was revoked. Null unless the status is REVOKED. |
| `currentState.revokedBy` | publicCloud.lakehouse.CredentialRevokedByEnum | read-only | Who revoked the credential. Null unless the status is REVOKED. — one of `CUSTOMER`, `OPERATOR`, `SYSTEM` |
| `currentState.s3Access` | boolean | read-only | Whether the credential holds an S3 access key. True for the credential named `initial`, whose S3 key predates the credentials and is not returned in accessKey. |
| `currentState.status` | publicCloud.lakehouse.CredentialStatusEnum | read-only | Whether the credential works, computed from its expiry and revocation dates — one of `ACTIVE`, `EXPIRED`, `REVOKED` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the credential |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is `currentState.status`. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CredentialTargetSpec | read-only | Specification of the credential, as requested at creation and completed with the defaults |
| `targetSpec.expiresAt` | string (date-time) |  | Date the credential stops working. At least 10 minutes ahead and at most the lifetime limit of the lakehouse: 90 days unless OVHcloud set another limit. Immutable after creation. Defaults to that limit. |
| `targetSpec.name` | string |  | Name of the credential, 1 to 64 characters, not unique. Immutable after creation. Defaults to `credential-<yyyymmdd>` of the creation day. |
| `targetSpec.s3Access` | boolean |  | Whether the credential gets an S3 access key, for a tool that reads or writes the bucket directly. Apache Iceberg REST, SQL and the data console need none. Immutable after creation. Defaults to false. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the credential |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "currentState": {
      "accessKey": "string",
      "clientId": "string",
      "createdAt": "2024-01-01T12:00:00Z",
      "expiresAt": "2024-01-01T12:00:00Z",
      "name": "string",
      "revokedAt": "2024-01-01T12:00:00Z",
      "revokedBy": "CUSTOMER",
      "s3Access": true,
      "status": "ACTIVE"
    },
    "currentTasks": [
      {
        "errors": [
          {
            "message": "string"
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "link": "string",
        "status": "ERROR",
        "type": "string"
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "resourceStatus": "CREATING",
    "targetSpec": {
      "expiresAt": "2024-01-01T12:00:00Z",
      "name": "string",
      "s3Access": true
    },
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential");

print_r($result);
?>
```

## Create a credential for a user of your lakehouse and get its secrets

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#createLakehouseUserCredential

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credential/create`

Creates a credential and returns it with its secrets once, in this response: the client secret and the S3 secret key cannot be read again, so store them safely. The credential works for Apache Iceberg REST, SQL and S3, with the rights of the roles of the user, including those of its groups, until it expires or is revoked.

A credential expires after the lifetime limit of the lakehouse by default, and at most: 90 days unless OVHcloud set another limit for the lakehouse. An `expiresAt` beyond the limit is refused with a 400 whose details give the limit, and one less than 10 minutes ahead too. The name defaults to `credential-<yyyymmdd>` of the creation day and need not be unique.

The credential gets an S3 access key only when `targetSpec.s3Access` is true. Without one, `credentials.s3` is null. A user holds at most 3 ACTIVE credentials: one more is refused with a 409. The user must be READY: the creation is refused with a 409 otherwise. The creation is synchronous: it changes neither the target specification, nor the checksum, nor the status of the user, and records no task.

<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Request body (required)

Type: `publicCloud.lakehouse.CredentialCreation`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `targetSpec` | publicCloud.lakehouse.CredentialTargetSpec | yes | Specification of the credential to create. Send an empty object to take every default. |
| `targetSpec.expiresAt` | string (date-time) |  | Date the credential stops working. At least 10 minutes ahead and at most the lifetime limit of the lakehouse: 90 days unless OVHcloud set another limit. Immutable after creation. Defaults to that limit. |
| `targetSpec.name` | string |  | Name of the credential, 1 to 64 characters, not unique. Immutable after creation. Defaults to `credential-<yyyymmdd>` of the creation day. |
| `targetSpec.s3Access` | boolean |  | Whether the credential gets an S3 access key, for a tool that reads or writes the bucket directly. Apache Iceberg REST, SQL and the data console need none. Immutable after creation. Defaults to false. |

```json
{
  "targetSpec": {
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "s3Access": true
  }
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.IssuedCredential | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |
| 500 | object | Error 500 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the credential |
| `createdAt` | string (date-time) | read-only | Date the credential was created |
| `credentials` | publicCloud.lakehouse.Credentials | read-only | Connection details and secrets of the credential, returned once |
| `credentials.catalogUri` | string | read-only | Base URI of the Apache Iceberg REST catalog of the region, for your Iceberg client |
| `credentials.catalogs` | publicCloud.lakehouse.CredentialsCatalog[] | read-only | Catalogs reached at the time of issue by the roles of the user, including those of its groups, sorted by `warehouse`. Empty when they reach none. |
| `credentials.catalogs[].catalogId` | string (uuid) | read-only | Identifier of the catalog |
| `credentials.catalogs[].sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>` |
| `credentials.catalogs[].warehouse` | string | read-only | Warehouse name of the catalog, for your Apache Iceberg client |
| `credentials.clientId` | string | read-only | OAuth2 client identifier of the credential |
| `credentials.clientSecret` | string (password) | read-only | OAuth2 client secret of the credential. Returned only once, in the response that issues it. |
| `credentials.realm` | string | read-only | Realm of the lakehouse, to send in the `Polaris-Realm` header of your Apache Iceberg client |
| `credentials.s3` | publicCloud.lakehouse.CredentialsS3 | read-only | S3 key of the credential for direct access to the storage of the lakehouse. Null when the credential was created without S3 access, or when the region does not issue S3 keys. |
| `credentials.s3.accessKey` | string | read-only | S3 access key |
| `credentials.s3.bucket` | string | read-only | Bucket holding the data of the lakehouse. Null when the bucket is not created yet. |
| `credentials.s3.endpoint` | string | read-only | S3 endpoint of the region |
| `credentials.s3.region` | publicCloud.lakehouse.RegionEnum | read-only | S3 region name to configure in your S3 client — one of `eu-west-par`, `eu-west-poc` |
| `credentials.s3.secretKey` | string (password) | read-only | S3 secret key. Returned only once, in the response that issues it. |
| `credentials.tokenUri` | string | read-only | URI of the OAuth2 token service, where your client exchanges the client identifier and secret for a token |
| `currentState` | publicCloud.lakehouse.CredentialCurrentState | read-only | Current state of the credential, computed by the service |
| `currentState.accessKey` | string | read-only | S3 access key of the credential. Null when the credential was created without S3 access, and for the credential named `initial` whose S3 key was issued before credentials existed. |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the credential |
| `currentState.createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState.expiresAt` | string (date-time) | read-only | Date the credential stops working |
| `currentState.name` | string | read-only | Name of the credential |
| `currentState.revokedAt` | string (date-time) | read-only | Date the credential was revoked. Null unless the status is REVOKED. |
| `currentState.revokedBy` | publicCloud.lakehouse.CredentialRevokedByEnum | read-only | Who revoked the credential. Null unless the status is REVOKED. — one of `CUSTOMER`, `OPERATOR`, `SYSTEM` |
| `currentState.s3Access` | boolean | read-only | Whether the credential holds an S3 access key. True for the credential named `initial`, whose S3 key predates the credentials and is not returned in accessKey. |
| `currentState.status` | publicCloud.lakehouse.CredentialStatusEnum | read-only | Whether the credential works, computed from its expiry and revocation dates — one of `ACTIVE`, `EXPIRED`, `REVOKED` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the credential |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is `currentState.status`. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CredentialTargetSpec | read-only | Specification of the credential, as requested at creation and completed with the defaults |
| `targetSpec.expiresAt` | string (date-time) |  | Date the credential stops working. At least 10 minutes ahead and at most the lifetime limit of the lakehouse: 90 days unless OVHcloud set another limit. Immutable after creation. Defaults to that limit. |
| `targetSpec.name` | string |  | Name of the credential, 1 to 64 characters, not unique. Immutable after creation. Defaults to `credential-<yyyymmdd>` of the creation day. |
| `targetSpec.s3Access` | boolean |  | Whether the credential gets an S3 access key, for a tool that reads or writes the bucket directly. Apache Iceberg REST, SQL and the data console need none. Immutable after creation. Defaults to false. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the credential |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "credentials": {
    "catalogUri": "string",
    "catalogs": [
      {
        "catalogId": "00000000-0000-0000-0000-000000000000",
        "sqlCatalog": "string",
        "warehouse": "string"
      }
    ],
    "clientId": "string",
    "clientSecret": "string",
    "realm": "string",
    "s3": {
      "accessKey": "string",
      "bucket": "string",
      "endpoint": "string",
      "region": "eu-west-par",
      "secretKey": "string"
    },
    "tokenUri": "string"
  },
  "currentState": {
    "accessKey": "string",
    "clientId": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "revokedAt": "2024-01-01T12:00:00Z",
    "revokedBy": "CUSTOMER",
    "s3Access": true,
    "status": "ACTIVE"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "s3Access": true
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: publicCloud.lakehouse.CredentialCreation
result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential",
	targetSpec = None, # Specification of the credential to create. Send an empty object to take every default. (type: publicCloud.lakehouse.CredentialTargetSpec)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: publicCloud.lakehouse.CredentialCreation
$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential", array(
	targetSpec => null, // Specification of the credential to create. Send an empty object to take every default. (type: publicCloud.lakehouse.CredentialTargetSpec)
));

print_r($result);
?>
```

## Get a credential of a user of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getLakehouseUserCredential

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credential/get`

Returns the credential without its secrets, which are returned only once, at creation.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `credentialId` | path | string (uuid) | yes | Credential ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Credential | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the credential |
| `createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState` | publicCloud.lakehouse.CredentialCurrentState | read-only | Current state of the credential, computed by the service |
| `currentState.accessKey` | string | read-only | S3 access key of the credential. Null when the credential was created without S3 access, and for the credential named `initial` whose S3 key was issued before credentials existed. |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the credential |
| `currentState.createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState.expiresAt` | string (date-time) | read-only | Date the credential stops working |
| `currentState.name` | string | read-only | Name of the credential |
| `currentState.revokedAt` | string (date-time) | read-only | Date the credential was revoked. Null unless the status is REVOKED. |
| `currentState.revokedBy` | publicCloud.lakehouse.CredentialRevokedByEnum | read-only | Who revoked the credential. Null unless the status is REVOKED. — one of `CUSTOMER`, `OPERATOR`, `SYSTEM` |
| `currentState.s3Access` | boolean | read-only | Whether the credential holds an S3 access key. True for the credential named `initial`, whose S3 key predates the credentials and is not returned in accessKey. |
| `currentState.status` | publicCloud.lakehouse.CredentialStatusEnum | read-only | Whether the credential works, computed from its expiry and revocation dates — one of `ACTIVE`, `EXPIRED`, `REVOKED` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the credential |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is `currentState.status`. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CredentialTargetSpec | read-only | Specification of the credential, as requested at creation and completed with the defaults |
| `targetSpec.expiresAt` | string (date-time) |  | Date the credential stops working. At least 10 minutes ahead and at most the lifetime limit of the lakehouse: 90 days unless OVHcloud set another limit. Immutable after creation. Defaults to that limit. |
| `targetSpec.name` | string |  | Name of the credential, 1 to 64 characters, not unique. Immutable after creation. Defaults to `credential-<yyyymmdd>` of the creation day. |
| `targetSpec.s3Access` | boolean |  | Whether the credential gets an S3 access key, for a tool that reads or writes the bucket directly. Apache Iceberg REST, SQL and the data console need none. Immutable after creation. Defaults to false. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the credential |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "accessKey": "string",
    "clientId": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "revokedAt": "2024-01-01T12:00:00Z",
    "revokedBy": "CUSTOMER",
    "s3Access": true,
    "status": "ACTIVE"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "s3Access": true
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}");

print_r($result);
?>
```

## Delete a revoked or expired credential of a user of your lakehouse

`DELETE /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#deleteLakehouseUserCredential

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credential/delete`

Removes the record of a REVOKED or EXPIRED credential at once, before the purge that removes it 30 days after its revocation or expiry. The response is empty. The deletion is refused with a 409 while the credential is ACTIVE: revoke it first.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `credentialId` | path | string (uuid) | yes | Credential ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | — | successful operation |

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}");

print_r($result);
?>
```

## Revoke a credential of a user of your lakehouse

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}/revoke`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#revokeLakehouseUserCredential

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credential/revoke`

Revokes the credential at once: the response is the credential REVOKED. Access through Apache Iceberg REST and SQL stops at once, including the tokens and sessions already open. The S3 key of the credential, if it has one, is deleted: OVHcloud Object Storage may keep accepting it for up to 30 minutes. To refuse S3 access within about 3 minutes, revoke every credential of the user. The other credentials of the user keep working. A revocation cannot be undone.

The credential must be ACTIVE: the revocation is refused with a 409 otherwise. It records no task.

<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `credentialId` | path | string (uuid) | yes | Credential ID |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Credential | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |
| 500 | object | Error 500 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the credential |
| `createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState` | publicCloud.lakehouse.CredentialCurrentState | read-only | Current state of the credential, computed by the service |
| `currentState.accessKey` | string | read-only | S3 access key of the credential. Null when the credential was created without S3 access, and for the credential named `initial` whose S3 key was issued before credentials existed. |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the credential |
| `currentState.createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState.expiresAt` | string (date-time) | read-only | Date the credential stops working |
| `currentState.name` | string | read-only | Name of the credential |
| `currentState.revokedAt` | string (date-time) | read-only | Date the credential was revoked. Null unless the status is REVOKED. |
| `currentState.revokedBy` | publicCloud.lakehouse.CredentialRevokedByEnum | read-only | Who revoked the credential. Null unless the status is REVOKED. — one of `CUSTOMER`, `OPERATOR`, `SYSTEM` |
| `currentState.s3Access` | boolean | read-only | Whether the credential holds an S3 access key. True for the credential named `initial`, whose S3 key predates the credentials and is not returned in accessKey. |
| `currentState.status` | publicCloud.lakehouse.CredentialStatusEnum | read-only | Whether the credential works, computed from its expiry and revocation dates — one of `ACTIVE`, `EXPIRED`, `REVOKED` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the credential |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is `currentState.status`. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CredentialTargetSpec | read-only | Specification of the credential, as requested at creation and completed with the defaults |
| `targetSpec.expiresAt` | string (date-time) |  | Date the credential stops working. At least 10 minutes ahead and at most the lifetime limit of the lakehouse: 90 days unless OVHcloud set another limit. Immutable after creation. Defaults to that limit. |
| `targetSpec.name` | string |  | Name of the credential, 1 to 64 characters, not unique. Immutable after creation. Defaults to `credential-<yyyymmdd>` of the creation day. |
| `targetSpec.s3Access` | boolean |  | Whether the credential gets an S3 access key, for a tool that reads or writes the bucket directly. Apache Iceberg REST, SQL and the data console need none. Immutable after creation. Defaults to false. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the credential |

```json
{
  "checksum": "string",
  "createdAt": "2024-01-01T12:00:00Z",
  "currentState": {
    "accessKey": "string",
    "clientId": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "revokedAt": "2024-01-01T12:00:00Z",
    "revokedBy": "CUSTOMER",
    "s3Access": true,
    "status": "ACTIVE"
  },
  "currentTasks": [
    {
      "errors": [
        {
          "message": "string"
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "link": "string",
      "status": "ERROR",
      "type": "string"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "resourceStatus": "CREATING",
  "targetSpec": {
    "expiresAt": "2024-01-01T12:00:00Z",
    "name": "string",
    "s3Access": true
  },
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}/revoke" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}/revoke")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credential/{credentialId}/revoke");

print_r($result);
?>
```

## Deprecated: reset the credentials of a user of your lakehouse and get a new one

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/reset`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#resetLakehouseUserCredentials

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credentials/reset`

Deprecated, to be removed at the next breaking version of the API: create a credential and revoke credentials instead.

Revokes every ACTIVE credential of the user, then creates one credential named `reset` that expires 90 days later, and returns it once, in this response: the client secret and the S3 secret key cannot be read again, so store them safely. The revoked credentials stop working through Apache Iceberg REST and SQL at once, including the tokens and sessions already open. Their S3 keys are deleted and may keep working for up to 30 minutes. To stop S3 access within about 3 minutes, revoke the credentials of the user instead, then create a credential.

The user must be READY: the reset is refused with a 409 otherwise. The reset is synchronous: it changes neither the target specification, nor the checksum, nor the status of the user, and records no task.

<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Credentials | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |
| 500 | object | Error 500 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `catalogUri` | string | read-only | Base URI of the Apache Iceberg REST catalog of the region, for your Iceberg client |
| `catalogs` | publicCloud.lakehouse.CredentialsCatalog[] | read-only | Catalogs reached at the time of issue by the roles of the user, including those of its groups, sorted by `warehouse`. Empty when they reach none. |
| `catalogs[].catalogId` | string (uuid) | read-only | Identifier of the catalog |
| `catalogs[].sqlCatalog` | string | read-only | Name the SQL endpoint serves the catalog under: a table is `<sqlCatalog>.<schema>.<table>` |
| `catalogs[].warehouse` | string | read-only | Warehouse name of the catalog, for your Apache Iceberg client |
| `clientId` | string | read-only | OAuth2 client identifier of the credential |
| `clientSecret` | string (password) | read-only | OAuth2 client secret of the credential. Returned only once, in the response that issues it. |
| `realm` | string | read-only | Realm of the lakehouse, to send in the `Polaris-Realm` header of your Apache Iceberg client |
| `s3` | publicCloud.lakehouse.CredentialsS3 | read-only | S3 key of the credential for direct access to the storage of the lakehouse. Null when the credential was created without S3 access, or when the region does not issue S3 keys. |
| `s3.accessKey` | string | read-only | S3 access key |
| `s3.bucket` | string | read-only | Bucket holding the data of the lakehouse. Null when the bucket is not created yet. |
| `s3.endpoint` | string | read-only | S3 endpoint of the region |
| `s3.region` | publicCloud.lakehouse.RegionEnum | read-only | S3 region name to configure in your S3 client — one of `eu-west-par`, `eu-west-poc` |
| `s3.secretKey` | string (password) | read-only | S3 secret key. Returned only once, in the response that issues it. |
| `tokenUri` | string | read-only | URI of the OAuth2 token service, where your client exchanges the client identifier and secret for a token |

```json
{
  "catalogUri": "string",
  "catalogs": [
    {
      "catalogId": "00000000-0000-0000-0000-000000000000",
      "sqlCatalog": "string",
      "warehouse": "string"
    }
  ],
  "clientId": "string",
  "clientSecret": "string",
  "realm": "string",
  "s3": {
    "accessKey": "string",
    "bucket": "string",
    "endpoint": "string",
    "region": "eu-west-par",
    "secretKey": "string"
  },
  "tokenUri": "string"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/reset" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/reset")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/reset");

print_r($result);
?>
```

## Revoke every active credential of a user of your lakehouse

`POST /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/revoke`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#revokeLakehouseUserCredentials

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/credentials/revoke`

Revokes every ACTIVE credential of the user at once: the response lists the credentials revoked, empty when the user had none. Access through Apache Iceberg REST and SQL stops at once, including the tokens and sessions already open. The S3 key is refused within about 3 minutes. A revocation cannot be undone.

The user keeps its roles and its group memberships, and may get new credentials at once. The revocation changes neither the target specification, nor the checksum, nor the status of the user, and records no task.

<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | publicCloud.lakehouse.Credential[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |
| 409 | object | Error 409 response |
| 500 | object | Error 500 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `checksum` | string | read-only | Hash of the target specification of the credential |
| `createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState` | publicCloud.lakehouse.CredentialCurrentState | read-only | Current state of the credential, computed by the service |
| `currentState.accessKey` | string | read-only | S3 access key of the credential. Null when the credential was created without S3 access, and for the credential named `initial` whose S3 key was issued before credentials existed. |
| `currentState.clientId` | string | read-only | OAuth2 client identifier of the credential |
| `currentState.createdAt` | string (date-time) | read-only | Date the credential was created |
| `currentState.expiresAt` | string (date-time) | read-only | Date the credential stops working |
| `currentState.name` | string | read-only | Name of the credential |
| `currentState.revokedAt` | string (date-time) | read-only | Date the credential was revoked. Null unless the status is REVOKED. |
| `currentState.revokedBy` | publicCloud.lakehouse.CredentialRevokedByEnum | read-only | Who revoked the credential. Null unless the status is REVOKED. — one of `CUSTOMER`, `OPERATOR`, `SYSTEM` |
| `currentState.s3Access` | boolean | read-only | Whether the credential holds an S3 access key. True for the credential named `initial`, whose S3 key predates the credentials and is not returned in accessKey. |
| `currentState.status` | publicCloud.lakehouse.CredentialStatusEnum | read-only | Whether the credential works, computed from its expiry and revocation dates — one of `ACTIVE`, `EXPIRED`, `REVOKED` |
| `currentTasks` | common.CurrentTask[] | read-only | Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously. |
| `currentTasks[].errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `currentTasks[].errors[].message` | string | read-only | Error description |
| `currentTasks[].id` | string (uuid) | read-only | Identifier of the current task |
| `currentTasks[].link` | string | read-only | Link to the task details |
| `currentTasks[].status` | common.CurrentTaskStatusEnum | read-only | Current global status of the current task — one of `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `currentTasks[].type` | string | read-only | Type of the current task |
| `id` | string (uuid) | read-only | Unique identifier of the credential |
| `resourceStatus` | common.ResourceStatusEnum | read-only | Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is `currentState.status`. — one of `CREATING`, `CREATION_PLANNED`, `DELETING`, `ERROR`, `OUT_OF_SYNC`, `READY`, `SUSPENDED`, `UNKNOWN`, `UPDATING` |
| `targetSpec` | publicCloud.lakehouse.CredentialTargetSpec | read-only | Specification of the credential, as requested at creation and completed with the defaults |
| `targetSpec.expiresAt` | string (date-time) |  | Date the credential stops working. At least 10 minutes ahead and at most the lifetime limit of the lakehouse: 90 days unless OVHcloud set another limit. Immutable after creation. Defaults to that limit. |
| `targetSpec.name` | string |  | Name of the credential, 1 to 64 characters, not unique. Immutable after creation. Defaults to `credential-<yyyymmdd>` of the creation day. |
| `targetSpec.s3Access` | boolean |  | Whether the credential gets an S3 access key, for a tool that reads or writes the bucket directly. Apache Iceberg REST, SQL and the data console need none. Immutable after creation. Defaults to false. |
| `updatedAt` | string (date-time) | read-only | Date of the last change to the credential |

```json
[
  {
    "checksum": "string",
    "createdAt": "2024-01-01T12:00:00Z",
    "currentState": {
      "accessKey": "string",
      "clientId": "string",
      "createdAt": "2024-01-01T12:00:00Z",
      "expiresAt": "2024-01-01T12:00:00Z",
      "name": "string",
      "revokedAt": "2024-01-01T12:00:00Z",
      "revokedBy": "CUSTOMER",
      "s3Access": true,
      "status": "ACTIVE"
    },
    "currentTasks": [
      {
        "errors": [
          {
            "message": "string"
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "link": "string",
        "status": "ERROR",
        "type": "string"
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "resourceStatus": "CREATING",
    "targetSpec": {
      "expiresAt": "2024-01-01T12:00:00Z",
      "name": "string",
      "s3Access": true
    },
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/revoke" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/revoke")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/credentials/revoke");

print_r($result);
?>
```

## List the events of a user of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/event`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getLakehouseUserEvents

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/event/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `taskId` | query | string (uuid) |  | Return only the events of this task |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Event[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the event |
| `kind` | string | read-only | Nature of the event |
| `link` | string | read-only | Link to the event related resource |
| `message` | string | read-only | Description of what happened on the event |
| `type` | common.EventTypeEnum | read-only | Type of the event — one of `TARGET_SPEC_UPDATE`, `TASK_ERROR`, `TASK_START`, `TASK_SUCCESS` |

```json
[
  {
    "createdAt": "2024-01-01T12:00:00Z",
    "kind": "string",
    "link": "string",
    "message": "string",
    "type": "TARGET_SPEC_UPDATE"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/event" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/event")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/event");

print_r($result);
?>
```

## List the tasks of a user of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getAllLakehouseUserTasks

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/task/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `X-Pagination-Cursor` | header | string |  | Pagination cursor |
| `X-Pagination-Size` | header | integer |  | Pagination size |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Task[] | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the task |
| `errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `errors[].message` | string | read-only | Error description |
| `finishedAt` | string (date-time) | read-only | Ending date of the task |
| `id` | string (uuid) | read-only | Unique identifier of the task |
| `link` | string | read-only | Link to the related resource |
| `message` | string | read-only | Description of the task |
| `progress` | common.TaskProgress[] | read-only | Progress steps of the asynchronous operation |
| `progress[].name` | string | read-only | Progress step name |
| `progress[].status` | common.TaskStatusEnum | read-only | Current status of the progress step — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `startedAt` | string (date-time) | read-only | Starting date of the task |
| `status` | common.TaskStatusEnum | read-only | Current global status of the task — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `type` | string | read-only | Type of the task |
| `updatedAt` | string (date-time) | read-only | Last update of the task |

```json
[
  {
    "createdAt": "2024-01-01T12:00:00Z",
    "errors": [
      {
        "message": "string"
      }
    ],
    "finishedAt": "2024-01-01T12:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "link": "string",
    "message": "string",
    "progress": [
      {
        "name": "string",
        "status": "DONE"
      }
    ],
    "startedAt": "2024-01-01T12:00:00Z",
    "status": "DONE",
    "type": "string",
    "updatedAt": "2024-01-01T12:00:00Z"
  }
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task");

print_r($result);
?>
```

## Get a task of a user of your lakehouse

`GET /v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task/{taskId}`

Link: https://developers.eu.ovhcloud.com/reference/public-cloud/analytics/lakehouse/users/#getLakehouseUserTask

**Status:** Alpha version  
**IAM actions:** `publicCloudProject:apiovh:analytics/lakehouse/user/task/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `lakehouseId` | path | string (uuid) | yes | Lakehouse ID |
| `projectId` | path | string | yes | Project ID |
| `taskId` | path | string (uuid) | yes | Task ID |
| `userId` | path | string (uuid) | yes | User ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | common.Task | successful operation |
| 400 | object | Error 400 response |
| 404 | object | Error 404 response |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the task |
| `errors` | common.TaskError[] | read-only | Errors that occurred on the task |
| `errors[].message` | string | read-only | Error description |
| `finishedAt` | string (date-time) | read-only | Ending date of the task |
| `id` | string (uuid) | read-only | Unique identifier of the task |
| `link` | string | read-only | Link to the related resource |
| `message` | string | read-only | Description of the task |
| `progress` | common.TaskProgress[] | read-only | Progress steps of the asynchronous operation |
| `progress[].name` | string | read-only | Progress step name |
| `progress[].status` | common.TaskStatusEnum | read-only | Current status of the progress step — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `startedAt` | string (date-time) | read-only | Starting date of the task |
| `status` | common.TaskStatusEnum | read-only | Current global status of the task — one of `DONE`, `ERROR`, `PENDING`, `RUNNING`, `SCHEDULED`, `WAITING_USER_INPUT` |
| `type` | string | read-only | Type of the task |
| `updatedAt` | string (date-time) | read-only | Last update of the task |

```json
{
  "createdAt": "2024-01-01T12:00:00Z",
  "errors": [
    {
      "message": "string"
    }
  ],
  "finishedAt": "2024-01-01T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "link": "string",
  "message": "string",
  "progress": [
    {
      "name": "string",
      "status": "DONE"
    }
  ],
  "startedAt": "2024-01-01T12:00:00Z",
  "status": "DONE",
  "type": "string",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task/{taskId}" \
  -H "accept: application/json" \
  -H "X-Schemas-Version: 2026-06" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task/{taskId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/user/{userId}/task/{taskId}");

print_r($result);
?>
```
