CIPP.app icon

CIPP.app

Manage Microsoft 365 tenants via CIPP.app

Actions619

CIPP v10.6 → List SharePoint External Users

AI-generated

Summary

Lists SharePoint external users for a tenant through CIPP v10.6. Choose whether to include a tenant filter, then set the result cap or return all results; additional query parameters can refine the request.

Inputs

  • Include Tenant — Defaults to true. When enabled, adds the selected Tenant as tenantFilter; when disabled, omits the tenant filter.
  • Tenant (required) — Tenant sent as tenantFilter when Include Tenant is enabled. Select it from the tenant list or enter a domain. The field is hidden when Include Tenant is disabled.
  • Return All — Defaults to false. When false, returns up to Limit results; when true, requests all results.
  • Limit — Defaults to 50; maximum 500. Caps results when Return All is false.
  • Query Parameters — JSON object of additional query parameters.
  • Max Payload Bytes — Maximum serialized request body size; defaults to 262144 bytes.

Output shape

A list of SharePoint external user records.

The result count follows Return All and Limit. The source pack provided does not expose this operation's runtime implementation details, so response field names and exact pagination behavior are unspecified.

Examples

Example 1: List external users for one tenant

Set Include Tenant to true, select the tenant, and leave Return All false to retrieve up to the default 50 results.

Example 2: List external users without a tenant filter

Set Include Tenant to false; the Tenant field is hidden and the request omits tenantFilter.

Links

Discussion