/{connector_id}/validate_credentials

Validate the customer's credentials and retrieve tenant information.

This operation verifies that the credentials provided by the customer are valid and active. It also retrieves identifying information about the customer's tenant/organization in the integrated application.

The credentials could have been obtained through various means, such as:

  • OAuth flow
  • API keys
  • Username/password
  • Service account credentials

This endpoint should be called:

  • After obtaining new credentials to verify they work
  • Before performing other operations to ensure credentials are still valid
  • To get the tenant identifier needed for other operations
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
auth
object

Authentication credentials, which can be one of several types.

credentials
array of objects
credentials
request
object
required

This is a hack to force creation of types that extend this model, that otherwise don't have any properties but we still want the Python types for.

boolean

Whether to include raw data in the response.

page
object

Pagination parameters for requests and responses.

settings
object

Connector-specific settings for the request.

These are settings that are shared across all capabilities.

Usually contain additional required configuration options not specified by the capability schema.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json