@labkey/api
    Preparing search index...

    Interface GetUsersOptions

    interface GetUsersOptions {
        active?: boolean;
        allMembers?: boolean;
        containerPath?: string;
        failure?: RequestFailure<any>;
        group?: string;
        groupId?: number;
        name?: string;
        permissions?: string | string[];
        scope?: any;
        success?: RequestSuccess<GetUsersResponse>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    active? allMembers? containerPath? failure? group? groupId? name? permissions? scope? success?

    Properties

    active?: boolean

    This value is used to filter members based on activity (defaults to false).

    allMembers?: boolean

    This value is used to fetch all members in subgroups.

    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.

    group?: string

    The name of a project group for which you want the members (specify groupId or group, not both).

    groupId?: number

    The id of a project group for which you want the members.

    name?: string

    The first part of the user name, useful for user name completion. If specified, only users whose email address or display name starts with the value supplied will be returned.

    permissions?: string | string[]

    A permissions string or an Array of permissions strings. If not present, no permission filtering occurs. If multiple permissions, all permissions are required.

    scope?: any

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

    success?: RequestSuccess<GetUsersResponse>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties