light-mode-image
Learn
API ReferenceMembers

Delete a tenant membership

Analytics Events

TENANT_MEMBERSHIP_DELETE_STARTTENANT_MEMBERSHIP_DELETE_SUCCESSTENANT_MEMBERSHIP_DELETE_FAIL
DELETE/v1/tenants/{tenantId}/memberships/{userId}

Removes the membership of a user from the specified tenant. This will remove all user permissions for this tenant.

Analytic events

  • TENANT_MEMBERSHIP_DELETE_START
  • TENANT_MEMBERSHIP_DELETE_SUCCESS
  • TENANT_MEMBERSHIP_DELETE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Identifier of the tenant the user is being removed from.

Formatuuid
userId*string

Identifier of the user being removed.

Formatuuid

Response Body

application/json

text/plain

curl -X DELETE "https://example.com/v1/tenants/543e0579-87b9-4705-be78-8f7f54709838/memberships/818f7564-49cb-4003-b041-37aec302e2c9"
Empty

How would you rate this page?