Dropbox: This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API

← Check operations · Get started

Operation dropbox.check_user

Provider route: POST /2/check/user. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["check"]["user"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.check.user(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_dropbox import DropboxIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.check.user(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Dropbox-API-Path-Root	Model	Optional	Expand Deletes a group — request body — headers Dropbox-API-Path-Root
headers.Dropbox-API-Select-User	string	Optional
headers.Dropbox-API-Select-Admin	string	Optional
body	Model	Required within parent	Expand This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API — request body — body

Referenced models: This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API — request body — body, Deletes a group — request body — headers Dropbox-API-Path-Root

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API — response body

Referenced models: This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API — response body

Schemas

This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Contains the arguments to be sent to the Dropbox servers.
query	string	Optional	Maximum length: 500

This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API — response body

Field	Type	Presence	Description and constraints
$	object	Root	EchoResult contains the result returned from the Dropbox servers.
result	string	Optional

Deletes a group — request body — headers Dropbox-API-Path-Root

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: home
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: home
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: root
$ (anyOf 3).root	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: namespace_id
$ (anyOf 4).namespace_id	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tag	string	Required within parent	Pattern: ^(?!(?:home|root|namespace_id)$)

Policy, approvals and errors

SDK function policy ID: dropbox.check_user. Catalog operation: check/user. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["account_info.read"]

Official provider source