Cancel tenant invitation

DELETE

/api/admin/tenants/{id}/invitations/{inv_id}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/admin/tenants/example/invitations/example \
  --header 'Authorization: Bearer <token>'

Deletes a tenant invitation after verifying the authenticated admin can access the tenant.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

inv_id

required

string

Responses

200

Tenant invitation cancelled.

Media type application/json

object

success

required

boolean

key

additional properties

Example

{
  "success": true
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}