ROrossum
Integration Credential

Test integration credential

Changed on

Test an existing integration credential: Rossum attempts to obtain an access token from the third-party service and, when the token carries the granted scopes, checks that all requested scopes were granted.

An optional secret in the request body is merged into the stored secret with the same semantics as a partial update — send only the keys to change, [redacted...] values keep the stored ones. The merged secret is only used for the test and is not saved, so an edit can be tested before submitting it.

post/api/v1/integration_credentials/{integrationCredentialID}/test

Request

Path parameters

integrationCredentialIDinteger required

A unique integer value identifying this integration credential.

Request body

Example request

{
  "secret": {
    "client_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "client_secret": "s3cr3t-value",
    "base_api_url": "https://example.coupahost.com",
    "scope": "core.invoice.create core.common.read"
  }
}

Response

OK

status'ok' | 'failed' required

ok when a token was obtained and no requested scope is missing, failed otherwise.

errorstring nullable required

Human-readable description of the failure. null when the test passed.

granted_scopesstring[] nullable required

Scopes granted in the issued token. null when the token could not be obtained or the granted scopes could not be determined.

missing_scopesstring[] nullable required

Requested scopes that are not granted in the issued token. null when the granted scopes could not be determined.

Example response

{
  "status": "ok",
  "granted_scopes": [
    "core.common.read",
    "core.invoice.create"
  ],
  "missing_scopes": []
}

Changes