Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface GetRestrictions

    interface GetRestrictions {
        expand?: string[];
        id: string;
        limit?: number;
        start?: number;
    }
    Index

    Properties

    expand? id limit? start?

    Properties

    expand?: string[]

    A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: restrictions.user, restrictions.group.

    • restrictions.user returns the piece of content that the restrictions are applied to.
    • restrictions.group returns the piece of content that the restrictions are applied to.
    • content returns the piece of content that the restrictions are applied to.
    id: string

    The ID of the content to be queried for its restrictions.

    limit?: number

    The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

    start?: number

    The starting index of the users and groups in the returned restrictions.

    Settings

    Member Visibility

    On This Page

    Properties