Skip to content
docstack-ocr

Revoke Invite

POST
/v1/admin/users/{user_id}/revoke-invite
 
curl --request POST \
  --url http://localhost:8080/v1/admin/users/example/revoke-invite

Revoke a pending invite and remove the invited-shell user.

Only valid while user.status == 'invited' — once the user has accepted (status=‘active’ or ‘suspended’) they have a real identity and the right operator action is DELETE /users/{id}, which preserves the row for audit. Revoke-invite, in contrast, hard-deletes the user (no audit row would be useful to keep since the user never existed beyond the invite shell). The USER_INVITE_REVOKED audit event captures the decision; the row itself is gone so the same email can be re-invited cleanly later.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
user_id
required
User Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Response Revoke Invite V1 Admin Users User Id Revoke Invite Post
object
key
additional properties
any
Example generated
{}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}