Members

Deactivate member

Deactivate a specific user by memberId. Users cannot be fully deleted, only deactivated. The deactivated user's documents are reassigned to the user associated with the API client credentials. For more information, see Deactivate users.

Usage notes

  • Retrieve the memberId by calling the /v2/members endpoint.
  • The user is directly marked archived by this API. See Deactivate users for more details on deactivation.

Usage scenarios

  • User offboarding: Manage your user base by efficiently offboarding users after they leave your organization.

Best practices

  • Confirm memberId: Before deactivating a user, make sure the memberId is correct.
  • Do not use this for members provisioned through SCIM.
delete/v2/members/{memberId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

memberIdstring required

Response

The response body.

MembersDeleteMemberResponse200 required

Changes

No recorded changes to this operation across all 1 revision of this API.