{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"user": "<string>",
"group": "<string>",
"layer": "<string>",
"folder": "<string>",
"table": "<string>",
"volume": "<string>",
"granted_by": "<string>"
}Catalog
Permission object
A single Catalog grant: one recipient, one resource, one level.
A Catalog grant is always one recipient on one resource at one level. There is no row that means “these three tables” — Assign Permissions expands a bulk request into individual grants, and each one is an object of this shape.
Exactly one of
| Field | Type | Notes |
|---|---|---|
id | UUID | |
permission_level | viewer | editor | manager | The only mutable field. |
user | UUID | Set when the recipient is a person. Expandable. |
group | UUID | Set when the recipient is a permission group. Expandable. |
layer | UUID | Expandable. |
folder | UUID | Expandable. |
table | UUID | Expandable. |
volume | UUID | Expandable. |
granted_by | UUID | Who created the grant. For an API key, its creator. Expandable. |
created_at | datetime | |
updated_at | datetime |
user / group is set, and exactly one of layer / folder / table / volume. The rest are null. That is a database constraint, not a convention, so you can branch on it safely.
Any field marked expandable can be inflated into the full object with ?expand= — see Expanding Responses.
Field types and formats are also rendered on the operation pages, for example under the response of List Permissions.
manager- Managereditor- Editorviewer- Viewer
Available options:
manager, editor, viewer User (Expandable)
Group (Expandable)
Layer (Expandable)
Folder (Expandable)
Table (Expandable)
Volume (Expandable)
Granted by (Expandable)
Was this page helpful?