Revoke a CLI: effective on its next request; optional signed remove + key rotation

POST

/v1/devices/{id}/revoke

curl --request POST \
  --url https://app.skillpouch.net/v1/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revoke \
  --header 'Content-Type: application/json' \
  --data '{ "roster": { "statements": [ { "statement": "example", "signature": "example" } ], "key_envelopes": [] }, "reason": "example" }'

Parameters

Path Parameters

id

required

string format: uuid

/^([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)$/

Request Body^required

Media typeapplication/json

object

roster

object

statements

required

Array<object>

>= 1 items <= 16 items

object

statement

required

string

<= 87382 characters /^[A-Za-z0-9_-]*$/

signature

required

string

<= 342 characters /^[A-Za-z0-9_-]*$/

key_envelopes

Array<object>

default: <= 2000 items

object

pouch_id

required

string format: uuid

/^([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)$/

member_id

required

string format: uuid

/^([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)$/

key_gen

required

integer

>= 1 <= 9007199254740991

hpke_enc

required

string

<= 342 characters /^[A-Za-z0-9_-]*$/

ciphertext

required

string

<= 5462 characters /^[A-Za-z0-9_-]*$/

created_by_member

required

string format: uuid

/^([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)$/

signature

required

string

<= 342 characters /^[A-Za-z0-9_-]*$/

reason

string

<= 200 characters

Responses

200

Default Response

Media typeapplication/json

object

ok

required

boolean

data

required

object

revoked

required

boolean

rotation_pending

required

boolean

meta

required

object

request_id

required

string

next_cursor

string | null

Example

{
  "ok": true,
  "data": {
    "revoked": true
  }
}