Data source connections

Revoke an external authentication link

Revokes a not-yet-used external authentication link so it can no longer be used to authenticate. Idempotent — revoking an already-revoked link returns 200 with the existing revocation data. Returns 400 if the link was already used or has expired.

post/api/v3/datasources/{datasource_name}/external-auth-links/{id}/revoke

Request

Path parameters

datasource_namestring required

Data source name

idinteger required

External authentication link ID

Response

Link revoked

idinteger

External authentication link ID

data_sourcestring

Data source name

data_source_titlestring

Human-readable data source title

status'not_used' | 'used' | 'expired' | 'revoked_manually'

Current status of the link

created_atstring date-time

When the link was generated

sent_to_emailstring email

Email of the external user the link was generated for

senderstring email

Email of the user who generated the link

revoked_atstring date-time nullable

When the link was revoked, if it was

revoked_bystring

Email of the user who revoked the link; empty string if not revoked

Changes

No recorded changes to this operation across all 1 revision of this API.