Type Alias: GetEnterprise

type GetEnterprise = object;

Defined in: parameters/getEnterprise.ts:86

Type Declaration

fields?

optional fields?: 
  | "name"
  | "id"
  | string & object
  | "prefs"
  | "products"
  | "idOrganizations"
  | "displayName"
  | "idMembers"
  | "ssoActivationFailed"
  | "idAdmins"
  | "userTypes"
  | (
  | "name"
  | "id"
  | string & object
  | "prefs"
  | "products"
  | "idOrganizations"
  | "displayName"
  | "idMembers"
  | "ssoActivationFailed"
  | "idAdmins"
  | "userTypes")[];

Comma-separated list of: id, name, displayName, prefs, ssoActivationFailed, idAdmins, idMembers (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.), idOrganizations, products, userTypes, idMembers, idOrganizations

id

id: string;

ID of the enterprise to retrieve.

memberCount?

optional memberCount?: number;

0 to 100

memberFields?

optional memberFields?: 
  | "username"
  | string & object
  | "fullName"
  | "avatarHash"
  | "initials"
  | ("username" | string & object | "fullName" | "avatarHash" | "initials")[];

One of: avatarHash, fullName, initials, username

memberFilter?

optional memberFilter?: string;

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

members?

optional members?: "all" | "none" | "normal" | string & object | "admins" | "owners";

One of: none, normal, admins, owners, all

memberSort?

optional memberSort?: 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.

memberSortBy?

optional memberSortBy?: string;

Deprecated: Please use member_sort. 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, and the API response's header will contain the total count and pagination state.

memberSortOrder?

optional memberSortOrder?: "desc" | string & object | "ascending" | "descending" | "asc";

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

memberStartIndex?

optional memberStartIndex?: number;

Any integer between 0 and 100.

organizationFields?

optional organizationFields?: string | string[];

Any valid value that the nested organization field resource accepts.

organizationMemberships?

optional organizationMemberships?: string;

Comma-seperated list of: me, normal, admin, active, deactivated

organizationPaidAccounts?

optional organizationPaidAccounts?: boolean;

Whether or not to include paid account information in the returned workspace objects

organizations?

optional organizations?: "all" | "none" | "public" | string & object | "members";

One of: none, members, public, all