trello.js

English

Русский

English

Русский

Appearance

Type Alias: GetEnterpriseMembers ​

ts
type GetEnterpriseMembers = object;

Defined in: parameters/getEnterpriseMembers.ts:100

Type Declaration ​

boardFields? ​

ts
optional boardFields?: string | string[];

Any valid value that the nested board resource accepts.

count? ​

ts
optional count?: string;

SCIM-style filter.

fields? ​

ts
optional fields?: 
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations"
  | (
  | "id"
  | "url"
  | "username"
  | "status"
  | string & object
  | "fullName"
  | "activityBlocked"
  | "avatarHash"
  | "avatarUrl"
  | "bio"
  | "bioData"
  | "confirmed"
  | "idEnterprise"
  | "idMemberReferrer"
  | "idPremOrgsAdmin"
  | "initials"
  | "memberType"
  | "nonPublic"
  | "nonPublicAvailable"
  | "products"
  | "idBoards"
  | "idOrganizations")[];

A comma-seperated list of valid member fields.

filter? ​

ts
optional filter?: string | null;

Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the below member_* args are set, the member array will be paginated.

id ​

ts
id: string;

ID of the Enterprise to retrieve.

organizationFields? ​

ts
optional organizationFields?: string | string[];

Any valid value that the nested organization field resource accepts.

sort? ​

ts
optional sort?: string;

This parameter expects a SCIM-style sorting value prefixed by a - to sort descending. If no - is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.

sortBy? ​

ts
optional sortBy?: string;

Deprecated: Please use sort instead. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.

sortOrder? ​

ts
optional sortOrder?: 
  | "desc"
  | "null"
  | string & object
  | "ascending"
  | "descending"
  | "asc"
  | null;

Deprecated: Please use sort instead. One of: ascending, descending, asc, desc.

startIndex? ​

ts
optional startIndex?: number;

Any integer between 0 and 9999.