This object represents the request for the 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:

'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"
}
interface AddPermissionToSpace {
    links?: GenericLinks;
    operation: {
        key: string;
        target: string;
    };
    spaceKey: string;
    subject: PermissionSubject;
}

Hierarchy (view full)

Properties

links?: GenericLinks
operation: {
    key: string;
    target: string;
}

Type declaration

  • key: string
  • target: string

    The space or content type that the operation applies to.

spaceKey: string

The key of the space to be queried for its content.

Generated using TypeDoc v0.25.12