Check account connections for missing permissions

Request

Returns directory user accounts for a sales partner with information about whether each account requires user action (re-authentication or missing permissions).

Security

X-API-KEY or Authorization

Path

directoryTypestringrequired

Type of the directory

salesPartnerIdstringrequired

Id of the SalesPartner

Query

accountIdinteger, (int64)

Optional id of a single DirectoryUserAccount (the 'id' field of a check entry) to restrict the result to.

curl -i -X GET \
  'https://uberall.com/api/business-connections/{directoryType}/sales-partner/{salesPartnerId}/accounts-connections-check?accountId=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Account connection checks successfully retrieved

Body*/*

statusstringrequired

Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {}
}