Skip to navigation
AgentFS APIAgent Filesystem

Users Get

Preview
View as Markdown

Returns an active managed user owned by the authenticated Provider app. This pilot requires app authentication; tenant credentials are not supported.

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 an object.
userobjectRequired
User to retrieve.
Variant:
agent_filesystem.UserSelector.user_public_idobjectRequired
Selects the user by its public user ID for this Provider app.

Response headers

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

Response

Successful response
user_public_idstring1-256 characters
Public user ID for this Provider app.
emailstring or nullOptionalformat: "^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$"<=255 characters
Contact email address for the user, when provided.
namestring or nullOptional1-255 characters

Display name supplied by your system, when provided. Existing names can contain up to 255 Unicode code points. Creating or updating a user accepts at most 50; replace or clear a longer name on update.

tenant_idstring or nullOptional1-256 characters
Identifier of the tenant containing the user, when present.

Errors

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