Skip to content

appAuthorization.revokeAppAuthorization

DELETE
/v1/connections/{connectionId}/authorization
curl --request DELETE \
--url https://example.com/v1/connections/example/authorization \
--header 'Authorization: Bearer <token>'
connectionId
required
string
>= 1 characters

Success

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Revoked

Example

{
"_tag": "Revoked"
}

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExperienceInputInvalid
message
required
string

Example

{
"_tag": "ExperienceInputInvalid"
}

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example

{
"_tag": "AuthenticationRequired"
}

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppRestricted
restriction
required
object
cardUrl
required
string
reason
required
string
>= 1 characters
appealUrl
required
string

Example

{
"_tag": "AppRestricted"
}

ExperienceNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ExperienceNotFound
id
required
string

Example

{
"_tag": "ExperienceNotFound"
}

ConnectionCleanupPending | ConnectionConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ConnectionCleanupPending
connectionId
required
string
stage
required
string
Allowed values: Credentials Connection
message
required
string

Example

{
"_tag": "ConnectionCleanupPending",
"stage": "Credentials"
}

AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppDiscoveryFailed
reason
required
string
Allowed values: InvalidInput IncompatibleCard NoDeclaration NoUsableServices Document Http BlockedTarget Transport TooLarge Timeout Redirect Encoding
issues
required
Array<object>
object
url
required
string
reason
required
string
fieldPath
string

Example

{
"_tag": "AppDiscoveryFailed",
"reason": "InvalidInput"
}

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example

{
"_tag": "RateLimited"
}

AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppAuthorizationUnavailable

Example

{
"_tag": "AppAuthorizationUnavailable"
}