API Documentation
User DELETE

delete

User DELETE

Delete the user from the system specified by the email address.
Required Scope: Users, Delete

 

URL Parameters

  • Param Name
    Type
    Description
  • USER_EMAIL
    string
    Email address of the target user

Resource URL

https://api.syncplicity.com/ provisioning/user.svc/{USER_EMAIL}

Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 403
    403

    (Forbidden) - Not An Admin: The user attempting to execute this request is not a company administrator
    (Forbidden) - User Not An Employee
    (Forbidden) - Owner of the company cannot be removed
    (Forbidden) - Must always be at least one admin in a company

  • 404
    404

    (Not Found) - Email Address Unknown

Working...