Revoke Invitation
DELETE /invitations/{invitation_id}
DELETE /invitations/{invitation_id}Interactive request editor loads with JavaScript.
Authorization
BearerAdminToken Organization-scoped admin token. Read operations require a valid token, and write operations require a token with write permission.
In: header
Path Parameters
Invitation ID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "$AISIX_CP/invitations/$INVITATION_ID" \ -H "Authorization: Bearer $AISIX_TOKEN"Revoked
{
"revoked": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Request body or parameters failed validation.
{
"error": {
"code": "string",
"message": "string"
}
}Missing or invalid bearer.
{
"error": {
"code": "UNAUTHENTICATED",
"message": "no org context"
}
}Authenticated request is not permitted.
{
"error": {
"code": "CUSTOM_KEY_DISABLED",
"message": "custom API key values are disabled for this organization"
}
}Resource not found.
{
"error": {
"code": "NOT_FOUND",
"message": "provider key not found"
}
}Complete operation details and schema variants
DELETE /invitations/{invitation_id}
Revoke Invitation
Revoke a pending invitation so its link can no longer be
redeemed. An invitation that is already accepted, revoked or
expired is reported as 404 — there is nothing left to revoke.
Parameters
invitation_id(path, string, required): Invitation ID.
Responses
-
200: Revoked -
revoked(boolean, required): -
id(string, required): -
400: Request body or parameters failed validation. -
error(object, required): Error details. -
error.code(string, required): Machine-readable identifier. Examples:UNAUTHENTICATED,INVALID_REQUEST,MASTER_KEY_UNSET,INTERNAL. -
error.message(string, required): Human-readable explanation; safe to surface to operators. -
401: Missing or invalid bearer. Response fields (application/json): identical toDELETE /invitations/{invitation_id}, response 400 above. -
403: Authenticated request is not permitted. Response fields (application/json): identical toDELETE /invitations/{invitation_id}, response 400 above. -
404: Resource not found. Response fields (application/json): identical toDELETE /invitations/{invitation_id}, response 400 above.
cURL
curl -X DELETE '$AISIX_CP/invitations/{invitation_id}' -H 'Authorization: Bearer $AISIX_TOKEN'