@labkey/api
    Preparing search index...

    Interface RemoveGroupMembersOptions

    interface RemoveGroupMembersOptions {
        containerPath?: string;
        failure?: RequestFailure<any>;
        groupId: number;
        principalIds: number | number[];
        scope?: any;
        success?: RequestSuccess<{ removed: number[] }>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? failure? groupId principalIds scope? success?

    Properties

    containerPath?: string

    An alternate container path to get permissions from. If not specified, the current container path will be used.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    groupId: number

    The id of the group from which you want to remove the member.

    principalIds: number | number[]

    An integer id or array of ids of the users or groups you want to remove.

    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    success?: RequestSuccess<{ removed: number[] }>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties