레퍼런스HTTP APIAgents

Revoke an agent identity

DELETE
/v1/agents/{id}/identities/{identity_id}

Events from that app and team are dropped from then on, including events already waiting to be processed. Revoking one already revoked changes nothing and answers a null receipt_id; otherwise writes a revoke_agent_identity receipt. The agent's Slack channel bindings in that install are revoked with it. Linking again makes a new identity.

Auth: cookie session only; no scope. Idempotency-Key: ignored.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

id*string

The agent's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
identity_id*string

The agent identity's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Response Body

Success

application/json
  1. response
agent_identity*
receipt_id*|null
Example Request
curl -X DELETE 'https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "agent_identity": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",    "provider": "slack_bot",    "app_id": "string",    "team_id": "string",    "bot_user_id": "string",    "credential_ref": "string",    "status": "active",    "revision": 0,    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",    "created_at": "2019-08-24T14:15:22Z",    "revoked_at": "2019-08-24T14:15:22Z"  },  "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7"}