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

    Interface ContentRestrictionUpdate

    interface ContentRestrictionUpdate {
        operation: string;
        restrictions: {
            group?: { name: string; type: string }[];
            user?: {
                accountId: string;
                type: string;
                userKey?: string;
                username?: string;
            }[];
        };
    }
    Index

    Properties

    operation restrictions

    Properties

    operation: string

    The restriction operation applied to content.

    restrictions: {
        group?: { name: string; type: string }[];
        user?: {
            accountId: string;
            type: string;
            userKey?: string;
            username?: string;
        }[];
    }

    The users/groups that the restrictions will be applied to. At least one of user or group must be specified for this object.

    Type declaration

    • Optionalgroup?: { name: string; type: string }[]

      The groups that the restrictions will be applied to. This array must have at least one item, otherwise it should be omitted.

    • Optionaluser?: { accountId: string; type: string; userKey?: string; username?: string }[]

      The users that the restrictions will be applied to. This array must have at least one item, otherwise it should be omitted.

    Settings

    Member Visibility

    On This Page

    Properties