Skip to main content

List Users

GET 
/api/v1/infra/collections/:collectionId/users

Retrieves a paginated list of all users within a collection. Returns user summaries including names, identities, account status, and basic profile information for user management and access control.

Parameter Details​

Header Parameters​

  • integrationid (required): Unique identifier for the cloud provider integration configured in your Unizo account. This UUID associates the API request with the specific cloud account credentials and permissions.

Path Parameters​

  • collectionId (required): Unique identifier for the collection within the specified cloud provider. Format varies by provider:
    • AWS: Region identifier for compliance environments (e.g., us-east-1 for US compliance, eu-west-1 for GDPR compliance)
    • Google Cloud: Project ID for governance environments (e.g., prod-compliance-env, audit-data-project-2024)
    • Azure: Use "default" when no specific subscription or resource group mapping is configured
    • Other providers: Provider-specific collection identifiers

Query Parameters​

  • offset: Starting position for pagination (default: 0). Use this to skip a specific number of user records during user access reviews and identity audits. For example, offset=20 starts from the 21st user for large-scale compliance assessments.

  • limit: Maximum number of users to return per page (default: 50, max: 200). Optimize performance by requesting only the number of records you need for governance reporting and security analysis.

  • sort: Sort users by field name for identity management reviews. Use field names directly (e.g., name) or prefix with - for descending order (e.g., -name). Multiple fields supported for audit workflows: name,-emailAddress,isActive.

Request​

Responses​

Successful Operation