Skip to content

Variable: SpacePermissionV2Schema

ts
const SpacePermissionV2Schema: ZodObject<{
  _links: ZodOptional<ZodObject<{
     base: ZodOptional<ZodString>;
     byOperation: ZodOptional<ZodString>;
     collection: ZodOptional<ZodString>;
     context: ZodOptional<ZodString>;
     download: ZodOptional<ZodString>;
     editui: ZodOptional<ZodString>;
     edituiv2: ZodOptional<ZodString>;
     next: ZodOptional<ZodString>;
     prev: ZodOptional<ZodString>;
     self: ZodOptional<ZodString>;
     tinyui: ZodOptional<ZodString>;
     webui: ZodOptional<ZodString>;
  }, $loose>>;
  id: ZodNumber;
  operation: ZodObject<{
     key: ZodEnum<{
        administer: "administer";
        archive: "archive";
        copy: "copy";
        create: "create";
        delete: "delete";
        export: "export";
        move: "move";
        purge: "purge";
        purge_version: "purge_version";
        read: "read";
        restore: "restore";
        restrict_content: "restrict_content";
        update: "update";
        use: "use";
     }>;
     target: ZodEnum<{
        attachment: "attachment";
        blogpost: "blogpost";
        comment: "comment";
        page: "page";
        space: "space";
     }>;
  }, $loose>;
  subject: ZodObject<{
     identifier: ZodString;
     type: ZodEnum<{
        group: "group";
        user: "user";
     }>;
  }, $loose>;
}, $loose>;

Defined in: src/v1/models/spacePermissionV2.ts:37

This object represents a single space permission. Permissions consist of* at least one operation object with an accompanying subjects object.*

The following combinations of operation.key and operation.target values are* valid for the operation object:*

bash*
'create': 'page', 'blogpost', 'comment', 'attachment'*
'read': 'space'*
'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'*
'export': 'space'*
'administer': 'space'*
'archive': 'page'*
'restrict_content': 'space'*
```*

For example, to enable Delete Own permission, set the `operation` object to the following:*
```*
"operation": {*
    "key": "delete",*
    "target": "space"*
}*
```*
To enable Add/Delete Restrictions permissions, set the `operation` object to the following:*
```*
"operation": {*
    "key": "restrict_content",*
    "target": "space"*
}*