Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-133681213.9 KB
Connections

Revoke connection

In most cases the authorize link is provided in the /connections endpoint. Normally you don't need to manually generate these links.

Use this endpoint to revoke an existing OAuth connector.

Auth links will have a state parameter included to verify the validity of the request. This is the url your users will use to activate OAuth supported integration providers.

Vault handles the complete revoke flow for you and will redirect you to the dynamic redirect uri you have appended to the url.

get/vault/revoke/{service_id}/{application_id}

Path parameters

service_idstring required

Service ID of the resource to return

application_idstring required

Application ID of the resource to return

Query parameters

statestring required

An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks.

redirect_uristring required

The redirect uri to redirect to after the revoke flow is completed.

Response

Unexpected error

status_codenumber

HTTP status code

errorstring

Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

type_namestring

The type of error returned

messagestring

A human-readable message providing more details about the error.

refstring

Link to documentation of error type

Example response

{
  "status_code": 400,
  "error": "Bad Request",
  "type_name": "RequestHeadersValidationError",
  "message": "Invalid Params",
  "detail": "Missing Header: x-apideck-consumer-id",
  "ref": "https://developers.apideck.com/errors#unauthorizederror"
}