Skip to content

Roles

All operations require authentication.

15 operationsv2/publicCloud/project
View as Markdown (opens in a new tab)
Agent setup

List the roles of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role

Lists the six predefined roles first, then the custom roles. Every lakehouse holds the six predefined roles from its creation: LAKEHOUSE_ADMIN, USER_ADMIN, DATA_OWNER, DATA_EDITOR, DATA_VIEWER and METADATA_VIEWER. They cannot be changed or deleted, and are not counted in the role quota.

Roles give data access only, through the Apache Iceberg catalog, the SQL engines and the storage of the lakehouse. The calls to this API are authorized by OVHcloud IAM, whatever the roles of the lakehouse.

With the S3 key of one of its credentials, a user whose roles, its own or its groups', let it read the data of a catalog or schema can also list the object names, sizes and dates of the whole storage of the lakehouse, other catalogs included. It can read or change only the objects of the catalogs and schemas its roles reach.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Role[]successful operation
checksum
read-only
string

Hash of the target specification of the role. Send it back on update to make sure nobody changed the role in between.

createdAt
read-only
stringdate-time

Date the role was created

currentState
read-only
RoleCurrentState

Current state of the role, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role, and its last failed task while the role is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role. A change is accepted only in READY or ERROR. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. The predefined roles are always READY.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleTargetSpec

Last requested specification of the role

updatedAt
read-only
stringdate-time

Date of the last change to the role

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "assignmentCount": 0, "description": "string", "kind": "CUSTOM", "name": "string", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "targetState": "ACTIVE" } ], "predefinedKey": "DATA_EDITOR", "statusReason": { "code": "CANCELED", "message": "string" } }, "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", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } } ] }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a role of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleId
required
stringuuid

Role ID

Response

200Rolesuccessful operation
checksum
read-only
string

Hash of the target specification of the role. Send it back on update to make sure nobody changed the role in between.

createdAt
read-only
stringdate-time

Date the role was created

currentState
read-only
RoleCurrentState

Current state of the role, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role, and its last failed task while the role is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role. A change is accepted only in READY or ERROR. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. The predefined roles are always READY.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleTargetSpec

Last requested specification of the role

updatedAt
read-only
stringdate-time

Date of the last change to the role

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "assignmentCount": 0, "description": "string", "kind": "CUSTOM", "name": "string", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "targetState": "ACTIVE" } ], "predefinedKey": "DATA_EDITOR", "statusReason": { "code": "CANCELED", "message": "string" } }, "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", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}

Create a custom role in your lakehouseAlpha

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role

Creates the custom role asynchronously. The response is the role in CREATING, with the creation task in currentTasks: follow it on the task routes of the role, or read the role until its resourceStatus is READY or ERROR. A role gives nothing until it is assigned: see the role assignment routes.

Each permission gives privileges on one target: the whole lakehouse (every catalog, including catalogs created later), one catalog and everything in it, or one schema of a catalog. A role holds at most 50 permissions, and at most one per target. The privileges of a permission must form a combination the region can enforce: every privilege requires BROWSE. INSERT, UPDATE and DELETE come together and require SELECT and ALTER. ALTER requires SELECT. DROP requires INSERT, UPDATE and DELETE. Any other combination is refused with a 400 that lists the missing privileges.

The name is unique among the roles of the lakehouse, and the names of the predefined roles are reserved. The creation is refused with a 409 while the lakehouse, or a catalog or schema a permission targets, is being deleted.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

targetSpec
required
RoleTargetSpec

Specification of the role to create

Response

200Rolesuccessful operation
checksum
read-only
string

Hash of the target specification of the role. Send it back on update to make sure nobody changed the role in between.

createdAt
read-only
stringdate-time

Date the role was created

currentState
read-only
RoleCurrentState

Current state of the role, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role, and its last failed task while the role is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role. A change is accepted only in READY or ERROR. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. The predefined roles are always READY.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleTargetSpec

Last requested specification of the role

updatedAt
read-only
stringdate-time

Date of the last change to the role

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "assignmentCount": 0, "description": "string", "kind": "CUSTOM", "name": "string", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "targetState": "ACTIVE" } ], "predefinedKey": "DATA_EDITOR", "statusReason": { "code": "CANCELED", "message": "string" } }, "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", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a custom role of your lakehouseAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}

Deletes the custom role asynchronously. The response is the role in DELETING, with the deletion task in currentTasks. Once the deletion completes, the role and every route under it, its tasks included, answer 404. Deleting a role also deletes its role assignments: the identities that held it lose the access it gave them.

A predefined role cannot be deleted: the deletion is refused with a 409.

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

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleId
required
stringuuid

Role ID

Response

200Rolesuccessful operation
checksum
read-only
string

Hash of the target specification of the role. Send it back on update to make sure nobody changed the role in between.

createdAt
read-only
stringdate-time

Date the role was created

currentState
read-only
RoleCurrentState

Current state of the role, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role, and its last failed task while the role is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role. A change is accepted only in READY or ERROR. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. The predefined roles are always READY.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleTargetSpec

Last requested specification of the role

updatedAt
read-only
stringdate-time

Date of the last change to the role

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "assignmentCount": 0, "description": "string", "kind": "CUSTOM", "name": "string", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "targetState": "ACTIVE" } ], "predefinedKey": "DATA_EDITOR", "statusReason": { "code": "CANCELED", "message": "string" } }, "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", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}

Update a custom role of your lakehouseAlpha

PUT
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}

Replaces the role's target specification as a whole. The body carries the complete desired state of every field publicCloud.lakehouse.RoleUpdateTargetSpec exposes — description and permissions — so read the role first and restate every value you want to keep: a field left out of targetSpec is cleared, and permissions replaces the whole list of permissions, it is not merged with it. The permissions follow the rules of the creation.

The create-only field name cannot be changed once the role exists. It is deliberately absent from the update model, and sending it is rejected with a 400. A predefined role cannot be changed: the update is refused with a 409.

A permission whose catalog or schema was deleted (targetState TARGET_DELETED) can be sent back unchanged, so a body built from a read always succeeds. A new permission on a deleted catalog or schema is refused with a 404.

When only the description changes, or when the role has no role assignment, the change is applied at once: the response is 200 with the role READY. When the permissions of an assigned role change, or when the role is in ERROR, the change is applied asynchronously: the response is 202 with the role UPDATING and the new task in currentTasks. The update is refused with a 409 while the role is CREATING, UPDATING or DELETING.

The optional checksum guards against a lost update: when supplied it must match the role'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

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleId
required
stringuuid

Role ID

Request body (required)

checksum
string

Checksum of the role as you last read it. When set, the update is refused with a 409 checksum-mismatch conflict if the role changed since. When omitted or empty, no check is made.

targetSpec
required
RoleUpdateTargetSpec

New specification of the role. It replaces the whole current specification: an optional field you omit is reset to its default, and permissions replaces the whole list. Send only the fields of this model: a field that can only be set at creation is refused.

Response

200Rolesuccessful operation
checksum
read-only
string

Hash of the target specification of the role. Send it back on update to make sure nobody changed the role in between.

createdAt
read-only
stringdate-time

Date the role was created

currentState
read-only
RoleCurrentState

Current state of the role, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role, and its last failed task while the role is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role. A change is accepted only in READY or ERROR. A deletion is also accepted in CREATING and UPDATING and replaces the change in progress. The predefined roles are always READY.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleTargetSpec

Last requested specification of the role

updatedAt
read-only
stringdate-time

Date of the last change to the role

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "assignmentCount": 0, "description": "string", "kind": "CUSTOM", "name": "string", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "targetState": "ACTIVE" } ], "predefinedKey": "DATA_EDITOR", "statusReason": { "code": "CANCELED", "message": "string" } }, "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", "permissions": [ { "privileges": [ "ALTER" ], "target": { "catalogId": "00000000-0000-0000-0000-000000000000", "schemaId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } } ] }, "updatedAt": "2024-01-01T12:00:00Z"}

List the events of a role of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/event

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleId
required
stringuuid

Role ID

Query parameters

taskId
stringuuid

Return only the events of this task

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Event[]successful operation
createdAt
read-only
stringdate-time

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS
400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/event \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]

List the tasks of a role of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleId
required
stringuuid

Role ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "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 role of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task/{taskId}

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleId
required
stringuuid

Role ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleId = 00000000-0000-0000-0000-000000000000, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}

List the role assignments of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment

Lists every role assignment of the lakehouse, for every role and identity. To show the roles of one user, service account or group, or the identities holding one role, select the role assignments on targetSpec.identity or targetSpec.roleId.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200RoleAssignment[]successful operation
checksum
read-only
string

Hash of the target specification of the role assignment, which never changes after creation

createdAt
read-only
stringdate-time

Date the role assignment was created

currentState
read-only
RoleAssignmentCurrentState

Current state of the role assignment, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role assignment, and its last failed task while the role assignment is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role assignment

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role assignment. The role assignment cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR and CREATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleAssignmentTargetSpec

Last requested specification of the role assignment

updatedAt
read-only
stringdate-time

Date of the last change to the role assignment

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "identity": { "id": "string", "type": "GROUP" }, "identityName": "string", "roleId": "00000000-0000-0000-0000-000000000000", "roleName": "string", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "identity": { "id": "string", "type": "GROUP" }, "roleId": "00000000-0000-0000-0000-000000000000", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a role assignment of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleAssignmentId
required
stringuuid

Role assignment ID

Response

200RoleAssignmentsuccessful operation
checksum
read-only
string

Hash of the target specification of the role assignment, which never changes after creation

createdAt
read-only
stringdate-time

Date the role assignment was created

currentState
read-only
RoleAssignmentCurrentState

Current state of the role assignment, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role assignment, and its last failed task while the role assignment is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role assignment

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role assignment. The role assignment cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR and CREATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleAssignmentTargetSpec

Last requested specification of the role assignment

updatedAt
read-only
stringdate-time

Date of the last change to the role assignment

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleAssignmentId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "identity": { "id": "string", "type": "GROUP" }, "identityName": "string", "roleId": "00000000-0000-0000-0000-000000000000", "roleName": "string", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "identity": { "id": "string", "type": "GROUP" }, "roleId": "00000000-0000-0000-0000-000000000000", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } }, "updatedAt": "2024-01-01T12:00:00Z"}

Assign a role to an identity of your lakehouseAlpha

POST
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment

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

The identity is a user, a service account or a group of the lakehouse, and identity.type must match it, or the creation is refused with a 400. A role assigned to a group applies to every member of the group. Without scope, the identity holds the role as it is defined. With a CATALOG scope, it holds the permissions of the role only within that catalog. The predefined roles LAKEHOUSE_ADMIN and USER_ADMIN cover the whole lakehouse and refuse a scope with a 400.

The same role cannot be assigned twice to the same identity with the same scope. The creation is refused with a 409 while the lakehouse, the role, the identity or the scope catalog is being deleted, or while the same role assignment is still being removed. A role assignment cannot be changed after creation: delete it and assign the role again.

Assigning a role gives data access: whoever may call this route can give any role of the lakehouse to any of its identities. Management rights, granted in OVHcloud IAM, are not affected.

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

Request body (required)

targetSpec
required
RoleAssignmentTargetSpec

Specification of the role assignment to create

Response

200RoleAssignmentsuccessful operation
checksum
read-only
string

Hash of the target specification of the role assignment, which never changes after creation

createdAt
read-only
stringdate-time

Date the role assignment was created

currentState
read-only
RoleAssignmentCurrentState

Current state of the role assignment, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role assignment, and its last failed task while the role assignment is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role assignment

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role assignment. The role assignment cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR and CREATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleAssignmentTargetSpec

Last requested specification of the role assignment

updatedAt
read-only
stringdate-time

Date of the last change to the role assignment

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "identity": { "id": "string", "type": "GROUP" }, "identityName": "string", "roleId": "00000000-0000-0000-0000-000000000000", "roleName": "string", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "identity": { "id": "string", "type": "GROUP" }, "roleId": "00000000-0000-0000-0000-000000000000", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a role assignment of your lakehouseAlpha

DELETE
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}

Deletes the role assignment asynchronously. The response is the role assignment in DELETING, with the deletion task in currentTasks. Once the deletion completes, the role assignment and every route under it, its tasks included, answer 404, and the identity no longer holds the role.

The last Lakehouse Admin assignment of the lakehouse cannot be deleted: the deletion is refused with a 409 while it is the only role assignment of LAKEHOUSE_ADMIN that is not being deleted. Assign the Lakehouse Admin role to another identity first. The rule counts role assignments, not the people they reach: an assignment to an empty group counts.

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

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleAssignmentId
required
stringuuid

Role assignment ID

Response

200RoleAssignmentsuccessful operation
checksum
read-only
string

Hash of the target specification of the role assignment, which never changes after creation

createdAt
read-only
stringdate-time

Date the role assignment was created

currentState
read-only
RoleAssignmentCurrentState

Current state of the role assignment, computed by the service

currentTasks
read-only
CurrentTask[]

Tasks in progress on the role assignment, and its last failed task while the role assignment is in ERROR. Always an array. Empty when there is none.

id
read-only
stringuuid

Unique identifier of the role assignment

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the role assignment. The role assignment cannot be changed: delete it and create it again. A deletion is accepted in READY, ERROR and CREATING, and replaces the change in progress.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
RoleAssignmentTargetSpec

Last requested specification of the role assignment

updatedAt
read-only
stringdate-time

Date of the last change to the role assignment

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleAssignmentId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "identity": { "id": "string", "type": "GROUP" }, "identityName": "string", "roleId": "00000000-0000-0000-0000-000000000000", "roleName": "string", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" }, "statusReason": { "code": "CANCELED", "message": "string" } }, "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": { "identity": { "id": "string", "type": "GROUP" }, "roleId": "00000000-0000-0000-0000-000000000000", "scope": { "catalogId": "00000000-0000-0000-0000-000000000000", "type": "CATALOG" } }, "updatedAt": "2024-01-01T12:00:00Z"}

List the events of a role assignment of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/event

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleAssignmentId
required
stringuuid

Role assignment ID

Query parameters

taskId
stringuuid

Return only the events of this task

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Event[]successful operation
createdAt
read-only
stringdate-time

Creation date of the event

kind
read-only
string

Nature of the event

link
read-only
string

Link to the event related resource

message
read-only
string

Description of what happened on the event

type
read-only
EventTypeEnum

Type of the event

ValuesTARGET_SPEC_UPDATETASK_ERRORTASK_STARTTASK_SUCCESS
400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleAssignmentId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/event \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "link": "string", "message": "string", "type": "TARGET_SPEC_UPDATE" }]

List the tasks of a role assignment of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleAssignmentId
required
stringuuid

Role assignment ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleAssignmentId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "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 role assignment of your lakehouseAlpha

GET
/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task/{taskId}

Path parameters

lakehouseId
required
stringuuid

Lakehouse ID

projectId
required
string

Project ID

roleAssignmentId
required
stringuuid

Role assignment ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

400objectError 400 response
404objectError 404 response

Example uses lakehouseId = 00000000-0000-0000-0000-000000000000, projectId = string, roleAssignmentId = 00000000-0000-0000-0000-000000000000, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "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"}