Users
All operations require authentication.
List the users of your lakehouseAlpha
Path parameters
Lakehouse ID
Project ID
Headers
Pagination cursor
Pagination size
Response
Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between.
Date the user was created
Current state of the user, computed by the service
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.
Unique identifier of the user
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.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the user
Date of the last change to the user
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user \
-H "authorization: Bearer $OVH_TOKEN"[ { "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" }]
Get a user of your lakehouseAlpha
Path parameters
Lakehouse ID
Project ID
User ID
Response
Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between.
Date the user was created
Current state of the user, computed by the service
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.
Unique identifier of the user
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.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the user
Date of the last change to the user
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Create a user in your lakehouseAlpha
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.
* 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.
Path parameters
Lakehouse ID
Project ID
Request body (required)
Specification of the user to create
Response
Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between.
Date the user was created
Current state of the user, computed by the service
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.
Unique identifier of the user
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.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the user
Date of the last change to the user
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Delete a user of your lakehouseAlpha
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.
Path parameters
Lakehouse ID
Project ID
User ID
Response
Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between.
Date the user was created
Current state of the user, computed by the service
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.
Unique identifier of the user
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.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the user
Date of the last change to the user
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Update a user of your lakehouseAlpha
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).
Path parameters
Lakehouse ID
Project ID
User ID
Request body (required)
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.
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.
Response
Hash of the target specification of the user. Send it back on update to make sure nobody changed the user in between.
Date the user was created
Current state of the user, computed by the service
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.
Unique identifier of the user
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.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast requested specification of the user
Date of the last change to the user
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
List the credentials of a user of your lakehouseAlpha
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.
Path parameters
Lakehouse ID
Project ID
User ID
Headers
Pagination cursor
Pagination size
Response
Hash of the target specification of the credential
Date the credential was created
Current state of the credential, computed by the service
Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously.
Unique identifier of the credential
Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is currentState.status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGSpecification of the credential, as requested at creation and completed with the defaults
Date of the last change to the credential
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credential \
-H "authorization: Bearer $OVH_TOKEN"[ { "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" }]
Create a credential for a user of your lakehouse and get its secretsAlpha
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.
* 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.
Path parameters
Lakehouse ID
Project ID
User ID
Request body (required)
Specification of the credential to create. Send an empty object to take every default.
Response
Hash of the target specification of the credential
Date the credential was created
Connection details and secrets of the credential, returned once
Current state of the credential, computed by the service
Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously.
Unique identifier of the credential
Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is currentState.status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGSpecification of the credential, as requested at creation and completed with the defaults
Date of the last change to the credential
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credential \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Get a credential of a user of your lakehouseAlpha
Returns the credential without its secrets, which are returned only once, at creation.
Path parameters
Credential ID
Lakehouse ID
Project ID
User ID
Response
Hash of the target specification of the credential
Date the credential was created
Current state of the credential, computed by the service
Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously.
Unique identifier of the credential
Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is currentState.status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGSpecification of the credential, as requested at creation and completed with the defaults
Date of the last change to the credential
Example uses credentialId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credential/ {credentialId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Delete a revoked or expired credential of a user of your lakehouseAlpha
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.
Path parameters
Credential ID
Lakehouse ID
Project ID
User ID
Response
Example uses credentialId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credential/ {credentialId} \
-H "authorization: Bearer $OVH_TOKEN"Revoke a credential of a user of your lakehouseAlpha
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.
* 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.
Path parameters
Credential ID
Lakehouse ID
Project ID
User ID
Response
Hash of the target specification of the credential
Date the credential was created
Current state of the credential, computed by the service
Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously.
Unique identifier of the credential
Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is currentState.status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGSpecification of the credential, as requested at creation and completed with the defaults
Date of the last change to the credential
Example uses credentialId = 00000000-0000-0000-0000-000000000000, lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credential/ {credentialId}/ revoke \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Deprecated: reset the credentials of a user of your lakehouse and get a new oneAlpha
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.
* 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.
Path parameters
Lakehouse ID
Project ID
User ID
Response
Base URI of the Apache Iceberg REST catalog of the region, for your Iceberg client
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.
OAuth2 client identifier of the credential
OAuth2 client secret of the credential. Returned only once, in the response that issues it.
Realm of the lakehouse, to send in the Polaris-Realm header of your Apache Iceberg client
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.
URI of the OAuth2 token service, where your client exchanges the client identifier and secret for a token
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credentials/ reset \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}
Revoke every active credential of a user of your lakehouseAlpha
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.
* 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.
Path parameters
Lakehouse ID
Project ID
User ID
Response
Hash of the target specification of the credential
Date the credential was created
Current state of the credential, computed by the service
Tasks in progress on the credential. Always an empty array: a credential is created and revoked synchronously.
Unique identifier of the credential
Readiness status of the credential. Always READY: a credential is created and revoked synchronously. Whether it still works is currentState.status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGSpecification of the credential, as requested at creation and completed with the defaults
Date of the last change to the credential
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ credentials/ revoke \
-H "authorization: Bearer $OVH_TOKEN"[ { "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" }]
List the events of a user of your lakehouseAlpha
Path parameters
Lakehouse ID
Project ID
User ID
Query parameters
Return only the events of this task
Headers
Pagination cursor
Pagination size
Response
Creation date of the event
Nature of the event
Link to the event related resource
Description of what happened on the event
Type of the event
TARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESSExample uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ event \
-H "authorization: Bearer $OVH_TOKEN"[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]
List the tasks of a user of your lakehouseAlpha
Path parameters
Lakehouse ID
Project ID
User ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ task \
-H "authorization: Bearer $OVH_TOKEN"[ { "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" }]
Get a task of a user of your lakehouseAlpha
Path parameters
Lakehouse ID
Project ID
Task ID
User ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, taskId = 00000000-0000-0000-0000-000000000000, userId = 00000000-0000-0000-0000-000000000000
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ managedAnalytics/ lakehouse/ {lakehouseId}/ user/ {userId}/ task/ {taskId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}