api-keys

DELETE /v1/api-keys/{apiKeyId}

Revoke an API key.

כל נקודות הקצה מסוג api-keys

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה apikeys.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X DELETE https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Revokes the key — it stops authenticating immediately and drops out of the list. The revocation is recorded in the audit log. Requires `apikeys.manage`.

פרמטרים

שםסוגנדרשמה זה
apiKeyId (path)UuidכןThe API key's id.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 409