Skip to content

Variable: MultiDirectoryGroupSearchRequestSchema ​

ts
const MultiDirectoryGroupSearchRequestSchema: ZodObject<{
  accountIds: ZodOptional<ZodArray<ZodString>>;
  cursor: ZodOptional<ZodString>;
  directoryIds: ZodOptional<ZodArray<ZodString>>;
  expand: ZodOptional<ZodArray<ZodCustom<string & object | "counts.resources" | "counts.users", string & object | "counts.resources" | "counts.users">>>;
  groupIds: ZodOptional<ZodArray<ZodString>>;
  groupNames: ZodOptional<ZodArray<ZodString>>;
  limit: ZodOptional<ZodNumber>;
  resourceIds: ZodOptional<ZodArray<ZodString>>;
  resourceOwners: ZodOptional<ZodArray<ZodString>>;
  roleIds: ZodOptional<ZodArray<ZodString>>;
  searchTerm: ZodOptional<ZodString>;
  sortBy: ZodOptional<ZodArray<ZodObject<{
     direction: ZodCustom<"desc" | string & object | "asc", "desc" | string & object | "asc">;
     field: ZodCustom<"name" | string & object, "name" | string & object>;
  }, ApiObjectConfig<undefined>>>>;
}, ApiObjectConfig<undefined>>;

Defined in: src/admin/models/multiDirectoryGroupSearchRequest.ts:13

Filters for searching groups in a directory.

The request body is optional — sending an empty body returns the first page of all groups in the directory.

Use expand to include additional count fields. Other count toggles are not exposed on this endpoint; the expand array is the only way to request counts.resources or counts.users.