{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.CurrentTask":{"type":"object","description":"Asynchronous operation currently running","properties":{"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"id":{"type":"string","description":"Identifier of the current task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the task details","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.CurrentTaskStatusEnum"}],"description":"Current global status of the current task","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the current task","readOnly":true}}},"common.CurrentTaskStatusEnum":{"type":"string","description":"Current status of a task. A task in ERROR cannot be retried without your inputs. PENDING tasks will be executed as soon as possible. A RUNNING task is currently executing your original request. SCHEDULED is used for tasks that will be executed in the future.","enum":["ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"common.Event":{"type":"object","description":"Represents an event for an async envelope","properties":{"createdAt":{"type":"string","description":"Creation date of the event","format":"date-time","readOnly":true},"kind":{"type":"string","description":"Nature of the event","readOnly":true},"link":{"type":"string","description":"Link to the event related resource","nullable":true,"readOnly":true},"message":{"type":"string","description":"Description of what happened on the event","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/common.EventTypeEnum"}],"description":"Type of the event","readOnly":true}}},"common.EventTypeEnum":{"type":"string","description":"Nature of an event","enum":["TARGET_SPEC_UPDATE","TASK_ERROR","TASK_START","TASK_SUCCESS"]},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"common.Task":{"type":"object","description":"Asynchronous operation","properties":{"createdAt":{"type":"string","description":"Creation date of the task","format":"date-time","readOnly":true},"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"finishedAt":{"type":"string","description":"Ending date of the task","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"string","description":"Unique identifier of the task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the related resource","readOnly":true},"message":{"type":"string","description":"Description of the task","readOnly":true},"progress":{"type":"array","description":"Progress steps of the asynchronous operation","items":{"$ref":"#/components/schemas/common.TaskProgress"},"readOnly":true},"startedAt":{"type":"string","description":"Starting date of the task","nullable":true,"format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current global status of the task","readOnly":true},"type":{"type":"string","description":"Type of the task","readOnly":true},"updatedAt":{"type":"string","description":"Last update of the task","format":"date-time","readOnly":true}}},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","readOnly":true}}},"common.TaskProgress":{"type":"object","description":"Detailed information about an asynchronous operation progress steps","properties":{"name":{"type":"string","description":"Progress step name","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current status of the progress step","readOnly":true}}},"common.TaskStatusEnum":{"type":"string","description":"Current status of a task","enum":["DONE","ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"publicCloud.lakehouse.IdentityReference":{"type":"object","description":"Reference to an identity of a lakehouse","properties":{"id":{"type":"string","description":"Identifier of the identity: the `id` of the lakehouse user, service account or group"},"type":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.IdentityTypeEnum"}],"description":"Kind of identity. It must match the identity referenced by `id`."}},"required":["id","type"]},"publicCloud.lakehouse.IdentityTypeEnum":{"type":"string","description":"Kind of identity a role is assigned to: a lakehouse user, service account or group. Values may be added.","enum":["GROUP","SERVICE_ACCOUNT","USER"]},"publicCloud.lakehouse.PermissionTarget":{"type":"object","description":"What the privileges of a permission apply to: the whole lakehouse, one catalog, or one schema of a catalog","properties":{"catalogId":{"type":"string","description":"Catalog of a CATALOG or SCHEMA target. Null, or omitted, on a LAKEHOUSE target.","nullable":true,"format":"uuid"},"schemaId":{"type":"string","description":"Schema of a SCHEMA target, which must belong to `catalogId`. Null, or omitted, on any other target.","nullable":true,"format":"uuid"},"type":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.PermissionTargetTypeEnum"}],"description":"Kind of target. The identifiers must match it, or the request is refused with a 400."}},"required":["type"]},"publicCloud.lakehouse.PermissionTargetStateEnum":{"type":"string","description":"State of the target of a role permission. `ACTIVE`: the target exists. `TARGET_DELETED`: the catalog or schema was deleted, and the permission gives nothing. Remove it, or send it back unchanged on update.","enum":["ACTIVE","TARGET_DELETED"]},"publicCloud.lakehouse.PermissionTargetTypeEnum":{"type":"string","description":"Kind of target of a role permission. `LAKEHOUSE`: every catalog of the lakehouse, including catalogs created later. `CATALOG`: one catalog and everything in it. `SCHEMA`: one schema of a catalog, and its tables and views. With SCHEMA targets only, SQL cannot list the schemas of the catalog, so name the schema in your queries. Values may be added.","enum":["CATALOG","LAKEHOUSE","SCHEMA"]},"publicCloud.lakehouse.PredefinedRoleEnum":{"type":"string","description":"Stable key of a predefined role. `LAKEHOUSE_ADMIN`: every data privilege on every catalog. The last Lakehouse Admin assignment cannot be removed. `USER_ADMIN`: no data privilege, management being granted in OVHcloud IAM. `DATA_OWNER`: read and change data, create, alter and drop tables and views. `DATA_EDITOR`: the same, without dropping. `DATA_VIEWER`: read data and metadata. `METADATA_VIEWER`: see the names of schemas, tables and views.","enum":["DATA_EDITOR","DATA_OWNER","DATA_VIEWER","LAKEHOUSE_ADMIN","METADATA_VIEWER","USER_ADMIN"]},"publicCloud.lakehouse.PrivilegeEnum":{"type":"string","description":"Data privilege of a role permission. `BROWSE`: see the names of the schemas, tables and views, without their columns. `SELECT`: read data and metadata. INSERT, UPDATE and DELETE: change data. They come together. `ALTER`: change the columns, the sort order and the format version of tables. `CREATE_TABLE`: create tables and views. `DROP`: drop tables and views. Values may be added.","enum":["ALTER","BROWSE","CREATE_TABLE","DELETE","DROP","INSERT","SELECT","UPDATE"]},"publicCloud.lakehouse.Role":{"type":"object","description":"A named set of data privileges of a lakehouse, which you assign to users, service accounts and groups. A role is predefined, created with the lakehouse and never changed, or custom. Roles give data access only: management rights are granted in OVHcloud IAM.","properties":{"checksum":{"type":"string","description":"Hash of the target specification of the role. Send it back on update to make sure nobody changed the role in between.","readOnly":true},"createdAt":{"type":"string","description":"Date the role was created","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleCurrentState"}],"description":"Current state of the role, computed by the service","readOnly":true},"currentTasks":{"type":"array","description":"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.","items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the role","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"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.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleTargetSpec"}],"description":"Last requested specification of the role","readOnly":true},"updatedAt":{"type":"string","description":"Date of the last change to the role","format":"date-time","readOnly":true}}},"publicCloud.lakehouse.RoleAssignment":{"type":"object","description":"A role held by a user, a service account or a group of a lakehouse, optionally within one catalog. A role assignment cannot be changed: delete it and assign the role again.","properties":{"checksum":{"type":"string","description":"Hash of the target specification of the role assignment, which never changes after creation","readOnly":true},"createdAt":{"type":"string","description":"Date the role assignment was created","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentCurrentState"}],"description":"Current state of the role assignment, computed by the service","readOnly":true},"currentTasks":{"type":"array","description":"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.","items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the role assignment","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"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.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentTargetSpec"}],"description":"Last requested specification of the role assignment","readOnly":true},"updatedAt":{"type":"string","description":"Date of the last change to the role assignment","format":"date-time","readOnly":true}}},"publicCloud.lakehouse.RoleAssignmentCreation":{"type":"object","description":"Creation of a role assignment","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentTargetSpec"}],"description":"Specification of the role assignment to create"}},"required":["targetSpec"]},"publicCloud.lakehouse.RoleAssignmentCurrentState":{"type":"object","description":"Current state of a role assignment, computed by the service","properties":{"identity":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.IdentityReference"}],"description":"User, service account or group that holds the role","readOnly":true},"identityName":{"type":"string","description":"Name of the user, service account or group that holds the role","readOnly":true},"roleId":{"type":"string","description":"Role assigned","format":"uuid","readOnly":true},"roleName":{"type":"string","description":"Name of the role assigned","readOnly":true},"scope":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentScope"}],"description":"Catalog the role is narrowed to. Null when the identity holds the role as it is defined.","nullable":true,"readOnly":true},"statusReason":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.StatusReason"}],"description":"Why the role assignment is in ERROR. Null in any other status.","nullable":true,"readOnly":true}}},"publicCloud.lakehouse.RoleAssignmentScope":{"type":"object","description":"Scope that narrows a role assignment. The identity holds the permissions of the role only within the scope. A scope never widens them.","properties":{"catalogId":{"type":"string","description":"Catalog the role is narrowed to. It must exist and not be being deleted.","format":"uuid"},"type":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentScopeTypeEnum"}],"description":"Kind of scope"}},"required":["catalogId","type"]},"publicCloud.lakehouse.RoleAssignmentScopeTypeEnum":{"type":"string","description":"Kind of scope of a role assignment. `CATALOG`: the role applies only within one catalog. Values may be added.","enum":["CATALOG"]},"publicCloud.lakehouse.RoleAssignmentTargetSpec":{"type":"object","description":"Specification of a role assignment, as you requested it","properties":{"identity":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.IdentityReference"}],"description":"User, service account or group that holds the role. Immutable after creation."},"roleId":{"type":"string","description":"Role assigned. Immutable after creation.","format":"uuid"},"scope":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentScope"}],"description":"Narrows the role to one catalog. Omit it, or set it to null, to hold the role as it is defined. Not accepted on the LAKEHOUSE_ADMIN and USER_ADMIN predefined roles. Immutable after creation.","nullable":true}},"required":["identity","roleId"]},"publicCloud.lakehouse.RoleCreation":{"type":"object","description":"Creation of a custom role","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleTargetSpec"}],"description":"Specification of the role to create"}},"required":["targetSpec"]},"publicCloud.lakehouse.RoleCurrentState":{"type":"object","description":"Current state of a role, computed by the service","properties":{"assignmentCount":{"type":"integer","description":"Number of role assignments of the role that are not being deleted","readOnly":true},"description":{"type":"string","description":"Description of the role. Null when it has none.","nullable":true,"readOnly":true},"kind":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleKindEnum"}],"description":"Whether the role is predefined or custom","readOnly":true},"name":{"type":"string","description":"Name of the role","readOnly":true},"permissions":{"type":"array","description":"Permissions of the role, each with the state of its target","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.RolePermissionState"},"readOnly":true},"predefinedKey":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.PredefinedRoleEnum"}],"description":"Stable key of a predefined role. Null on a custom role.","nullable":true,"readOnly":true},"statusReason":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.StatusReason"}],"description":"Why the role is in ERROR. Null in any other status.","nullable":true,"readOnly":true}}},"publicCloud.lakehouse.RoleKindEnum":{"type":"string","description":"Kind of role. `PREDEFINED`: created with the lakehouse, it cannot be changed or deleted. `CUSTOM`: created by you.","enum":["CUSTOM","PREDEFINED"]},"publicCloud.lakehouse.RolePermission":{"type":"object","description":"Privileges of a role on one target","properties":{"privileges":{"type":"array","description":"Privileges given on the target, at least one, each at most once. They 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.","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.PrivilegeEnum"}},"target":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.PermissionTarget"}],"description":"What the privileges apply to"}},"required":["privileges","target"]},"publicCloud.lakehouse.RolePermissionState":{"type":"object","description":"Privileges of a role on one target, with the state of the target","properties":{"privileges":{"type":"array","description":"Privileges given on the target","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.PrivilegeEnum"},"readOnly":true},"target":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.PermissionTarget"}],"description":"What the privileges apply to","readOnly":true},"targetState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.PermissionTargetStateEnum"}],"description":"Whether the target still exists. A permission whose target was deleted gives nothing.","readOnly":true}}},"publicCloud.lakehouse.RoleTargetSpec":{"type":"object","description":"Specification of a role, as you requested it","properties":{"description":{"type":"string","description":"Description of the role. At most 255 characters.","nullable":true},"name":{"type":"string","description":"Name of the role, unique in the lakehouse. Same rules as the lakehouse name. The names of the predefined roles (`lakehouse_admin`, `user_admin`, `data_owner`, `data_editor`, `data_viewer`, `metadata_viewer`) are reserved. Immutable after creation."},"permissions":{"type":"array","description":"Permissions of the role, at most 50 and at most one per target. They replace the whole list on update. An empty list gives nothing.","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.RolePermission"}}},"required":["name","permissions"]},"publicCloud.lakehouse.RoleUpdate":{"type":"object","description":"Update of a custom role","properties":{"checksum":{"type":"string","description":"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.","nullable":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleUpdateTargetSpec"}],"description":"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."}},"required":["targetSpec"]},"publicCloud.lakehouse.RoleUpdateTargetSpec":{"type":"object","description":"Specification of a custom role that you can change after creation","properties":{"description":{"type":"string","description":"Description of the role. At most 255 characters.","nullable":true},"permissions":{"type":"array","description":"Permissions of the role, at most 50 and at most one per target. They replace the whole list on update. A permission whose catalog or schema was deleted can be sent back unchanged.","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.RolePermission"}}},"required":["permissions"]},"publicCloud.lakehouse.StatusReason":{"type":"object","description":"Why a resource is in ERROR","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/publicCloud.lakehouse.StatusReasonCodeEnum"}],"description":"Stable code of the reason, for programs","readOnly":true},"message":{"type":"string","description":"Explanation of the reason, for people. It may change. Do not parse it.","readOnly":true}}},"publicCloud.lakehouse.StatusReasonCodeEnum":{"type":"string","description":"Stable code of the reason why a resource is in ERROR. CATALOG_NOT_EMPTY, LAKEHOUSE_NOT_EMPTY and SCHEMA_NOT_EMPTY: a deletion was refused because data remains. Delete again with force. DEDICATED_COMPUTE_POOL_EXISTS, DEDICATED_UNAVAILABLE, INVALID_SHAPE and QUOTA_EXCEEDED: the region refused the Compute Pool shape. `RECONCILE_FAILED`: a DEDICATED engine stopped serving. `CANCELED`: OVHcloud support canceled the change. `TIMED_OUT`: the change did not complete in time. `REGION_UNAVAILABLE`: the region could not take the change. `OPERATION_FAILED`: any other failure.","enum":["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"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role":{"get":{"operationId":"getAllLakehouseRoles","summary":"List the roles of your lakehouse","description":"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.\n\nRoles 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.\n\nWith 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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.Role"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@10"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudLakehouseRole"},"post":{"operationId":"createLakehouseRole","summary":"Create a custom role in your lakehouse","description":"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.\n\nEach 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.\n\nThe 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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleCreation"},"examples":{"Create a role":{"value":{"targetSpec":{"description":"Read the main catalog, change the orders schema","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"}},{"privileges":["ALTER","BROWSE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"}}]}},"summary":"Create a role that reads one catalog and changes the data of one of its schemas."}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Role"},"examples":{"Role being created":{"value":{"checksum":"c48bad4845c3cfdf8e8559d377e200c7","createdAt":"2026-10-01T09:08:00Z","currentState":{"assignmentCount":0,"description":"Read the main catalog, change the orders schema","kind":"CUSTOM","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"},"targetState":"ACTIVE"},{"privileges":["ALTER","BROWSE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"},"targetState":"ACTIVE"}],"predefinedKey":null,"statusReason":null},"currentTasks":[{"errors":[],"id":"8e1c4a7f-2d5b-4f39-a0c6-7b9e3d1f5a28","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/role/3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579/task/8e1c4a7f-2d5b-4f39-a0c6-7b9e3d1f5a28","status":"PENDING","type":"LAKEHOUSE_ROLE_CREATE"}],"id":"3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579","resourceStatus":"CREATING","targetSpec":{"description":"Read the main catalog, change the orders schema","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"}},{"privileges":["ALTER","BROWSE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"}}]},"updatedAt":"2026-10-01T09:08:00Z"},"summary":"The role in CREATING, with its creation task."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::DuplicatePermissionTarget":{"value":{"class":"Client::BadRequest::DuplicatePermissionTarget","message":"A role holds at most one permission per target"}},"Client::BadRequest::InvalidName":{"value":{"class":"Client::BadRequest::InvalidName","message":"Invalid name: use 3 to 63 lowercase letters, digits or underscores, starting with a letter"}},"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}},"Client::BadRequest::PermissionTargetMismatch":{"value":{"class":"Client::BadRequest::PermissionTargetMismatch","message":"The target does not match its type, or the schema does not belong to the catalog"}},"Client::BadRequest::PrivilegeCombinationNotEnforceable":{"value":{"class":"Client::BadRequest::PrivilegeCombinationNotEnforceable","message":"This combination of privileges cannot be enforced: add the missing privileges"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::CatalogDoesNotExist":{"value":{"class":"Client::NotFound::CatalogDoesNotExist","message":"Catalog not found"}},"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::SchemaDoesNotExist":{"value":{"class":"Client::NotFound::SchemaDoesNotExist","message":"Schema not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::NameAlreadyInUse":{"value":{"class":"Client::Conflict::NameAlreadyInUse","message":"This name is already in use"}},"Client::Conflict::QuotaExceeded":{"value":{"class":"Client::Conflict::QuotaExceeded","message":"This lakehouse has reached its quota"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@30"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.lakehouse.RoleCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role\",\n\ttargetSpec = None, # Specification of the role to create (type: publicCloud.lakehouse.RoleTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.lakehouse.RoleCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role\", array(\n\ttargetSpec => null, // Specification of the role to create (type: publicCloud.lakehouse.RoleTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/create","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}":{"delete":{"operationId":"deleteLakehouseRole","summary":"Delete a custom role of your lakehouse","description":"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.\n\nA predefined role cannot be deleted: the deletion is refused with a 409.\n\nA 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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleId","description":"Role ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Role"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ResourceAlreadyBeingDeleted":{"value":{"class":"Client::Conflict::ResourceAlreadyBeingDeleted","message":"Resource is already being deleted"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}},"Client::Conflict::RoleNotEditable":{"value":{"class":"Client::Conflict::RoleNotEditable","message":"Predefined roles cannot be modified or deleted"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@40"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/delete","required":true}]},"get":{"operationId":"getLakehouseRole","summary":"Get a role of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleId","description":"Role ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Role"},"examples":{"Custom role":{"value":{"checksum":"c48bad4845c3cfdf8e8559d377e200c7","createdAt":"2026-10-01T09:08:00Z","currentState":{"assignmentCount":0,"description":"Read the main catalog, change the orders schema","kind":"CUSTOM","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"},"targetState":"ACTIVE"},{"privileges":["ALTER","BROWSE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"},"targetState":"ACTIVE"}],"predefinedKey":null,"statusReason":null},"currentTasks":[],"id":"3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579","resourceStatus":"READY","targetSpec":{"description":"Read the main catalog, change the orders schema","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"}},{"privileges":["ALTER","BROWSE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"}}]},"updatedAt":"2026-10-01T09:08:40Z"},"summary":"A READY custom role."},"Predefined role":{"value":{"checksum":"f66f0d576c42c5773553410497fa0ffa","createdAt":"2026-10-01T09:00:00Z","currentState":{"assignmentCount":2,"description":"Every data privilege on every catalog of the lakehouse, including catalogs created later. Data access only: management rights are granted in OVHcloud IAM. The last Lakehouse Admin assignment of the lakehouse cannot be removed.","kind":"PREDEFINED","name":"lakehouse_admin","permissions":[{"privileges":["ALTER","BROWSE","CREATE_TABLE","DELETE","DROP","INSERT","SELECT","UPDATE"],"target":{"catalogId":null,"schemaId":null,"type":"LAKEHOUSE"},"targetState":"ACTIVE"}],"predefinedKey":"LAKEHOUSE_ADMIN","statusReason":null},"currentTasks":[],"id":"94df340d-8b93-5144-8730-327b33923d42","resourceStatus":"READY","targetSpec":{"description":"Every data privilege on every catalog of the lakehouse, including catalogs created later. Data access only: management rights are granted in OVHcloud IAM. The last Lakehouse Admin assignment of the lakehouse cannot be removed.","name":"lakehouse_admin","permissions":[{"privileges":["ALTER","BROWSE","CREATE_TABLE","DELETE","DROP","INSERT","SELECT","UPDATE"],"target":{"catalogId":null,"schemaId":null,"type":"LAKEHOUSE"}}]},"updatedAt":"2026-10-01T09:00:00Z"},"summary":"The predefined Lakehouse Admin role."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@20"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editLakehouseRole","summary":"Update a custom role of your lakehouse","description":"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.\n\nThe 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.\n\nA 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.\n\nWhen 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.\n\nThe 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).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleId","description":"Role ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleUpdate"},"examples":{"Update a role":{"value":{"checksum":"c48bad4845c3cfdf8e8559d377e200c7","targetSpec":{"description":"Read the main catalog, change and create tables in the orders schema","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"}},{"privileges":["ALTER","BROWSE","CREATE_TABLE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"}}]}},"summary":"Also let the role create tables in the schema. The body is the complete target specification that you can change."}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.Role"},"examples":{"Role being updated":{"value":{"checksum":"e82e0a780f9ee2f4ce064fb717e377bf","createdAt":"2026-10-01T09:08:00Z","currentState":{"assignmentCount":1,"description":"Read the main catalog, change the orders schema","kind":"CUSTOM","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"},"targetState":"ACTIVE"},{"privileges":["ALTER","BROWSE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"},"targetState":"ACTIVE"}],"predefinedKey":null,"statusReason":null},"currentTasks":[{"errors":[],"id":"4c7a2e9d-6f13-4b85-9e0a-1d3f8b6c2e57","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/role/3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579/task/4c7a2e9d-6f13-4b85-9e0a-1d3f8b6c2e57","status":"PENDING","type":"LAKEHOUSE_ROLE_UPDATE"}],"id":"3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579","resourceStatus":"UPDATING","targetSpec":{"description":"Read the main catalog, change and create tables in the orders schema","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"}},{"privileges":["ALTER","BROWSE","CREATE_TABLE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"}}]},"updatedAt":"2026-10-01T10:00:00Z"},"summary":"An assigned role in UPDATING, with its update task."},"Role updated":{"value":{"checksum":"e82e0a780f9ee2f4ce064fb717e377bf","createdAt":"2026-10-01T09:08:00Z","currentState":{"assignmentCount":0,"description":"Read the main catalog, change and create tables in the orders schema","kind":"CUSTOM","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"},"targetState":"ACTIVE"},{"privileges":["ALTER","BROWSE","CREATE_TABLE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"},"targetState":"ACTIVE"}],"predefinedKey":null,"statusReason":null},"currentTasks":[],"id":"3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579","resourceStatus":"READY","targetSpec":{"description":"Read the main catalog, change and create tables in the orders schema","name":"orders_editor","permissions":[{"privileges":["BROWSE","SELECT"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":null,"type":"CATALOG"}},{"privileges":["ALTER","BROWSE","CREATE_TABLE","DELETE","INSERT","SELECT","UPDATE"],"target":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","schemaId":"5e2d8a14-7c9b-4a36-b1f0-3d6e9c2a7b81","type":"SCHEMA"}}]},"updatedAt":"2026-10-01T10:00:00Z"},"summary":"A role without role assignment, READY with the change applied at once."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::DuplicatePermissionTarget":{"value":{"class":"Client::BadRequest::DuplicatePermissionTarget","message":"A role holds at most one permission per target"}},"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}},"Client::BadRequest::PermissionTargetMismatch":{"value":{"class":"Client::BadRequest::PermissionTargetMismatch","message":"The target does not match its type, or the schema does not belong to the catalog"}},"Client::BadRequest::PrivilegeCombinationNotEnforceable":{"value":{"class":"Client::BadRequest::PrivilegeCombinationNotEnforceable","message":"This combination of privileges cannot be enforced: add the missing privileges"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::CatalogDoesNotExist":{"value":{"class":"Client::NotFound::CatalogDoesNotExist","message":"Catalog not found"}},"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}},"Client::NotFound::SchemaDoesNotExist":{"value":{"class":"Client::NotFound::SchemaDoesNotExist","message":"Schema not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ChecksumMismatch":{"value":{"class":"Client::Conflict::ChecksumMismatch","message":"Checksum mismatch — a concurrent update was detected. Refresh the resource and retry"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}},"Client::Conflict::RoleNotEditable":{"value":{"class":"Client::Conflict::RoleNotEditable","message":"Predefined roles cannot be modified or deleted"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@50"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.lakehouse.RoleUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}\",\n\tchecksum = None, # 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. (type: string, nullable)\n\ttargetSpec = None, # 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. (type: publicCloud.lakehouse.RoleUpdateTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.lakehouse.RoleUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}\", array(\n\tchecksum => null, // 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. (type: string, nullable)\n\ttargetSpec => null, // 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. (type: publicCloud.lakehouse.RoleUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/edit","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/event":{"get":{"operationId":"getLakehouseRoleEvents","summary":"List the events of a role of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleId","description":"Role ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"query","name":"taskId","description":"Return only the events of this task","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Event"}},"examples":{"Creation history":{"value":[{"createdAt":"2026-10-01T09:08:40Z","kind":"LAKEHOUSE_ROLE_CREATE","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/role/3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579/task/8e1c4a7f-2d5b-4f39-a0c6-7b9e3d1f5a28","message":"Task completed","type":"TASK_SUCCESS"},{"createdAt":"2026-10-01T09:08:05Z","kind":"LAKEHOUSE_ROLE_CREATE","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/role/3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579/task/8e1c4a7f-2d5b-4f39-a0c6-7b9e3d1f5a28","message":"Task started","type":"TASK_START"},{"createdAt":"2026-10-01T09:08:00Z","kind":"LAKEHOUSE_ROLE_CREATE","link":null,"message":"Target specification updated","type":"TARGET_SPEC_UPDATE"}],"summary":"The events of a creation that completed."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@60"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/event\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/event\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/event/get","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task":{"get":{"operationId":"getAllLakehouseRoleTasks","summary":"List the tasks of a role of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleId","description":"Role ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Task"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@70"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/task/get","required":true}],"x-response-identifier":"id","x-expanded-response":"CommonTask"}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task/{taskId}":{"get":{"operationId":"getLakehouseRoleTask","summary":"Get a task of a role of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleId","description":"Role ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common.Task"},"examples":{"Completed task":{"value":{"createdAt":"2026-10-01T09:08:00Z","errors":[],"finishedAt":"2026-10-01T09:08:40Z","id":"8e1c4a7f-2d5b-4f39-a0c6-7b9e3d1f5a28","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/role/3b8d5f1a-9c2e-4a67-b4d0-e6f2a8c1d579/task/8e1c4a7f-2d5b-4f39-a0c6-7b9e3d1f5a28","message":"Change applied","progress":[{"name":"Provision the resource","status":"DONE"}],"startedAt":"2026-10-01T09:08:05Z","status":"DONE","type":"LAKEHOUSE_ROLE_CREATE","updatedAt":"2026-10-01T09:08:40Z"},"summary":"A creation task that completed."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}},"Client::NotFound::TaskDoesNotExist":{"value":{"class":"Client::NotFound::TaskDoesNotExist","message":"Task not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@80"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/role/{roleId}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/role/task/get","required":true}],"x-response-identifier":"id"}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment":{"get":{"operationId":"getAllLakehouseRoleAssignments","summary":"List the role assignments of your lakehouse","description":"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`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignment"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@90"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudLakehouseRoleAssignment"},"post":{"operationId":"createLakehouseRoleAssignment","summary":"Assign a role to an identity of your lakehouse","description":"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.\n\nThe 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.\n\nThe 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.\n\nAssigning 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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignmentCreation"},"examples":{"Assign a role":{"value":{"targetSpec":{"identity":{"id":"e9b5d3a1-4c7f-4e28-a6d0-8b2f1c9e5a43","type":"GROUP"},"roleId":"e568d2e0-dfd0-544e-ad34-90f22abe430a","scope":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","type":"CATALOG"}}},"summary":"Assign the Data Viewer role to a group, within one catalog."}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignment"},"examples":{"Role assignment being created":{"value":{"checksum":"6b83b91d1aa9265f2face98b6792dac4","createdAt":"2026-10-01T09:09:00Z","currentState":{"identity":{"id":"e9b5d3a1-4c7f-4e28-a6d0-8b2f1c9e5a43","type":"GROUP"},"identityName":"analysts","roleId":"e568d2e0-dfd0-544e-ad34-90f22abe430a","roleName":"data_viewer","scope":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","type":"CATALOG"},"statusReason":null},"currentTasks":[{"errors":[],"id":"9b3e7d1c-4a6f-4e82-b5d0-2f8c6a1e9d37","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/roleAssignment/6f2b9d4e-1a7c-4c58-b3e9-0d8a5f2c7b16/task/9b3e7d1c-4a6f-4e82-b5d0-2f8c6a1e9d37","status":"PENDING","type":"LAKEHOUSE_ROLE_ASSIGNMENT_CREATE"}],"id":"6f2b9d4e-1a7c-4c58-b3e9-0d8a5f2c7b16","resourceStatus":"CREATING","targetSpec":{"identity":{"id":"e9b5d3a1-4c7f-4e28-a6d0-8b2f1c9e5a43","type":"GROUP"},"roleId":"e568d2e0-dfd0-544e-ad34-90f22abe430a","scope":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","type":"CATALOG"}},"updatedAt":"2026-10-01T09:09:00Z"},"summary":"The role assignment in CREATING, with its creation task."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::IdentityTypeMismatch":{"value":{"class":"Client::BadRequest::IdentityTypeMismatch","message":"The identity type does not match the referenced user or group"}},"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}},"Client::BadRequest::RoleScopeNotAllowed":{"value":{"class":"Client::BadRequest::RoleScopeNotAllowed","message":"This role applies to the whole lakehouse and cannot be assigned with a scope"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::CatalogDoesNotExist":{"value":{"class":"Client::NotFound::CatalogDoesNotExist","message":"Catalog not found"}},"Client::NotFound::GroupDoesNotExist":{"value":{"class":"Client::NotFound::GroupDoesNotExist","message":"Group not found"}},"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleDoesNotExist":{"value":{"class":"Client::NotFound::RoleDoesNotExist","message":"Role not found"}},"Client::NotFound::UserDoesNotExist":{"value":{"class":"Client::NotFound::UserDoesNotExist","message":"User not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::QuotaExceeded":{"value":{"class":"Client::Conflict::QuotaExceeded","message":"This lakehouse has reached its quota"}},"Client::Conflict::ResourceAlreadyExists":{"value":{"class":"Client::Conflict::ResourceAlreadyExists","message":"This resource already exists"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@110"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.lakehouse.RoleAssignmentCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment\",\n\ttargetSpec = None, # Specification of the role assignment to create (type: publicCloud.lakehouse.RoleAssignmentTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.lakehouse.RoleAssignmentCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment\", array(\n\ttargetSpec => null, // Specification of the role assignment to create (type: publicCloud.lakehouse.RoleAssignmentTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/create","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}":{"delete":{"operationId":"deleteLakehouseRoleAssignment","summary":"Delete a role assignment of your lakehouse","description":"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.\n\nThe 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.\n\nA 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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleAssignmentId","description":"Role assignment ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignment"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleAssignmentDoesNotExist":{"value":{"class":"Client::NotFound::RoleAssignmentDoesNotExist","message":"Role assignment not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::LastLakehouseAdmin":{"value":{"class":"Client::Conflict::LastLakehouseAdmin","message":"The last Lakehouse Admin of a lakehouse cannot be removed: assign the Lakehouse Admin role to another identity first"}},"Client::Conflict::ResourceAlreadyBeingDeleted":{"value":{"class":"Client::Conflict::ResourceAlreadyBeingDeleted","message":"Resource is already being deleted"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@120"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/delete","required":true}]},"get":{"operationId":"getLakehouseRoleAssignment","summary":"Get a role assignment of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleAssignmentId","description":"Role assignment ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.lakehouse.RoleAssignment"},"examples":{"Role assignment":{"value":{"checksum":"6b83b91d1aa9265f2face98b6792dac4","createdAt":"2026-10-01T09:09:00Z","currentState":{"identity":{"id":"e9b5d3a1-4c7f-4e28-a6d0-8b2f1c9e5a43","type":"GROUP"},"identityName":"analysts","roleId":"e568d2e0-dfd0-544e-ad34-90f22abe430a","roleName":"data_viewer","scope":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","type":"CATALOG"},"statusReason":null},"currentTasks":[],"id":"6f2b9d4e-1a7c-4c58-b3e9-0d8a5f2c7b16","resourceStatus":"READY","targetSpec":{"identity":{"id":"e9b5d3a1-4c7f-4e28-a6d0-8b2f1c9e5a43","type":"GROUP"},"roleId":"e568d2e0-dfd0-544e-ad34-90f22abe430a","scope":{"catalogId":"c41a7e92-6b3d-4f05-8a2e-91d7b3c6e540","type":"CATALOG"}},"updatedAt":"2026-10-01T09:09:40Z"},"summary":"A READY role assignment of the Data Viewer role to a group, scoped to one catalog."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleAssignmentDoesNotExist":{"value":{"class":"Client::NotFound::RoleAssignmentDoesNotExist","message":"Role assignment not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@100"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/get","required":true}],"x-response-identifier":"id"}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/event":{"get":{"operationId":"getLakehouseRoleAssignmentEvents","summary":"List the events of a role assignment of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleAssignmentId","description":"Role assignment ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"query","name":"taskId","description":"Return only the events of this task","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Event"}},"examples":{"Creation history":{"value":[{"createdAt":"2026-10-01T09:09:40Z","kind":"LAKEHOUSE_ROLE_ASSIGNMENT_CREATE","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/roleAssignment/6f2b9d4e-1a7c-4c58-b3e9-0d8a5f2c7b16/task/9b3e7d1c-4a6f-4e82-b5d0-2f8c6a1e9d37","message":"Task completed","type":"TASK_SUCCESS"},{"createdAt":"2026-10-01T09:09:05Z","kind":"LAKEHOUSE_ROLE_ASSIGNMENT_CREATE","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/roleAssignment/6f2b9d4e-1a7c-4c58-b3e9-0d8a5f2c7b16/task/9b3e7d1c-4a6f-4e82-b5d0-2f8c6a1e9d37","message":"Task started","type":"TASK_START"},{"createdAt":"2026-10-01T09:09:00Z","kind":"LAKEHOUSE_ROLE_ASSIGNMENT_CREATE","link":null,"message":"Target specification updated","type":"TARGET_SPEC_UPDATE"}],"summary":"The events of a creation that completed."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleAssignmentDoesNotExist":{"value":{"class":"Client::NotFound::RoleAssignmentDoesNotExist","message":"Role assignment not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@130"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/event\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/event\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/event/get","required":true}]}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task":{"get":{"operationId":"getAllLakehouseRoleAssignmentTasks","summary":"List the tasks of a role assignment of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleAssignmentId","description":"Role assignment ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Task"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleAssignmentDoesNotExist":{"value":{"class":"Client::NotFound::RoleAssignmentDoesNotExist","message":"Role assignment not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@140"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/task/get","required":true}],"x-response-identifier":"id","x-expanded-response":"CommonTask"}},"/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task/{taskId}":{"get":{"operationId":"getLakehouseRoleAssignmentTask","summary":"Get a task of a role assignment of your lakehouse","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"lakehouseId","description":"Lakehouse ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"roleAssignmentId","description":"Role assignment ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common.Task"},"examples":{"Completed task":{"value":{"createdAt":"2026-10-01T09:09:00Z","errors":[],"finishedAt":"2026-10-01T09:09:40Z","id":"9b3e7d1c-4a6f-4e82-b5d0-2f8c6a1e9d37","link":"/v2/publicCloud/project/5f1c2b3a4d5e6f708192a3b4c5d6e7f8/managedAnalytics/lakehouse/8b0f6d2e-3c4a-4e1b-9f7d-2a6c5e8b1d30/roleAssignment/6f2b9d4e-1a7c-4c58-b3e9-0d8a5f2c7b16/task/9b3e7d1c-4a6f-4e82-b5d0-2f8c6a1e9d37","message":"Change applied","progress":[{"name":"Provision the resource","status":"DONE"}],"startedAt":"2026-10-01T09:09:05Z","status":"DONE","type":"LAKEHOUSE_ROLE_ASSIGNMENT_CREATE","updatedAt":"2026-10-01T09:09:40Z"},"summary":"A creation task that completed."}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::LakehouseDoesNotExist":{"value":{"class":"Client::NotFound::LakehouseDoesNotExist","message":"Lakehouse not found"}},"Client::NotFound::RoleAssignmentDoesNotExist":{"value":{"class":"Client::NotFound::RoleAssignmentDoesNotExist","message":"Role assignment not found"}},"Client::NotFound::TaskDoesNotExist":{"value":{"class":"Client::NotFound::TaskDoesNotExist","message":"Task not found"}}}}}}},"tags":["Managed Analytics","Lakehouse"],"x-developer-hub-navigation":[["Public Cloud","Analytics","Lakehouse","Roles@@@150"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedAnalytics/lakehouse/{lakehouseId}/roleAssignment/{roleAssignmentId}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:analytics/lakehouse/roleAssignment/task/get","required":true}],"x-response-identifier":"id"}}},"tags":[{"name":"Managed Analytics","x-tag-expanded":false,"description":"Missing description"},{"name":"Lakehouse","x-tag-expanded":false,"description":"Missing description"}]}
