Skip to navigation
AgentFS APIAgent Filesystem

Users List

Preview
View as Markdown

Lists active managed users owned by the authenticated Provider app. This pilot requires app authentication and rejects tenant selectors. Pagination is not a snapshot; concurrent creation/deletion can change results. Pages can be short or empty. Continue while next_cursor is present.

Required scope: private:agent_filesystem.users.manage OR private:agent_filesystem.tenant.users.manage

Endpoint format: RPC

Authentication: App

This endpoint does not support apps with the app folder permission.

Authentication

AuthorizationBearer

App-level OAuth 2.0 token (no user context). Use Authorization: Bearer <token>.

Obtain by calling the token endpoint with grant_type=client_credentials.

Only available on endpoints that declare app auth support.

OR
AuthorizationBearer

App-level OAuth 2.0 token (no user context). Use Authorization: Bearer <token>.

Obtain by calling the token endpoint with grant_type=client_credentials.

Only available on endpoints that declare app auth support.

Request

This endpoint expects a nullable object.
pageobject or nullOptional
Pagination controls, when needed.
tenantobject or nullOptional

Reserved for tenant filtering. Omit this field in the current app-only pilot; tenant selectors are not supported.

Variant:
agent_filesystem.TenantSelector.tenant_idobjectRequired
Selects the tenant by its Agent Filesystem ID.

Response headers

X-Dropbox-Request-IdstringOptional
A unique identifier for the request, useful for debugging and support.

Response

Successful response
userslist of objects
Users in this page.
next_cursorstring or nullOptional
Present when another page is available.

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error