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 full)

Properties

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

Properties

Optionalactive

active?: boolean

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

OptionalallMembers

allMembers?: boolean

This value is used to fetch all members in subgroups.

OptionalcontainerPath

containerPath?: string

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

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optionalgroup

group?: string

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

OptionalgroupId

groupId?: number

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

Optionalname

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.

Optionalpermissions

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.

Optionalscope

scope?: any

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

Optionalsuccess

success?: RequestSuccess<GetUsersResponse>

This will be called upon successfully completing a request.

Settings

Member Visibility

On This Page

Properties