Directory Design

Lists directories.

Directories are identity and authentication services that manage app user accounts. They support Caspio-native authentication as well as SAML-based federation (inbound from providers like Okta or Active Directory, and outbound to external systems). A Caspio account can have multiple directories for different user types (e.g., one for employees, another for customers). Each directory's Id is needed to query its users.

get/v4/directories

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/directories
  • Auth: API key in header Authorization

Query parameters

directoryNamestring

Case-insensitive substring filter on the directory name.

directoryIdstring

Exact-match filter on the directory identifier (6-character alphanumeric code).

sortFieldstring

Field to sort by. Valid values: "Name". Default: "Name".

sortDescendingboolean

When true, returns results in descending (Z→A) order. Default: false.

pageNumberinteger

Page number. Default: 1.

pageSizeinteger

Number of items per page. Range: 1–1000. Default: 100.

includeTriggeredActionsboolean

When true, includes triggered-action rules in each directory entry. Default: false.

bridgeAppIdstring

Filters results to objects associated with the specified Bridge application (GUID).

flexAppIdstring

Filters results to objects associated with the specified Flex application (GUID).

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.