Users: delete

Closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.

The response specifies whether whether the API execution succeeded (200 - OK) or failed (400 - Error). The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an errorDetails property with errorCode and message properties.

Request

HTTP request

DELETE /restapi/v2.1/accounts/{accountId}/users

Parameters

Parameter Name	Value	Description
Path Parameters
accountId	string	The external account number (int) or account ID GUID.
Optional Query Parameters
delete	string	ID of the user to delete. This parameter takes a comma-separated list of values in the format: `Groups,PermissionSet,SigningGroupsEmail`.

Request Body

userInfoList

Responses

Code	Description	Reference
200	Successful response.	usersResponse
400	Error encountered.	errorDetails

Code

Description

Reference

200

Successful response.

usersResponse

400

Error encountered.

errorDetails

SDK Method

Users::delete

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCode

string

The code associated with the error condition.

message

string

A brief message describing the error condition.

userInfo


`accountId`	string	The external account number (int) or account ID GUID.
`accountName`	string	The name on the account.
`activationAccessCode`	string	Access code provided to the user to activate the account.
`email`	string	The user's email address.
`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`loginStatus`	string	Boolean value that indicates whether the user is currently logged in or not.
`membershipId`	string	The user's membership ID.
`sendActivationEmail`	string	When set to true, specifies that an activation email be sent to the user.
`uri`	string	A URI containing the user ID.
`userId`	string	The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.
`userName`	string	The name of the user.
`userStatus`	string	Status of the user's account. One of: `ActivationRequired` `ActivationSent` `Active` `Closed` `Disabled`
`userType`	string	The type of user, for example `CompanyUser`.

userInfoList

users

[userInfo]

An array of userInfo objects containing information about the users in the group.

usersResponse


`endPosition`	string	The last index position in the result set.
`nextUri`	string	The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
`previousUri`	string	The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
`resultSetSize`	string	The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
`startPosition`	string	The starting index position of the current result set.
`totalSetSize`	string	The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
`users`	[userInfo]	User management information.

Examples

Generic JSON Request/Response

Request

{
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "email": "sample string 3",
      "userType": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "loginStatus": "sample string 7",
      "sendActivationEmail": "sample string 8",
      "activationAccessCode": "sample string 9"
    }
  ]
}

Response

{
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "email": "sample string 3",
      "userType": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "loginStatus": "sample string 7",
      "sendActivationEmail": "sample string 8",
      "activationAccessCode": "sample string 9",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ],
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6"
}

Generic XML Request/Response

Request

<userInfoList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <users>
    <userInfo>
      <activationAccessCode>sample string 9</activationAccessCode>
      <email>sample string 3</email>
      <loginStatus>sample string 7</loginStatus>
      <sendActivationEmail>sample string 8</sendActivationEmail>
      <uri>sample string 6</uri>
      <userId>sample string 2</userId>
      <userName>sample string 1</userName>
      <userStatus>sample string 5</userStatus>
      <userType>sample string 4</userType>
    </userInfo>
  </users>
</userInfoList>

Response

<usersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 4</endPosition>
  <nextUri>sample string 5</nextUri>
  <previousUri>sample string 6</previousUri>
  <resultSetSize>sample string 1</resultSetSize>
  <startPosition>sample string 3</startPosition>
  <totalSetSize>sample string 2</totalSetSize>
  <users>
    <userInfo>
      <activationAccessCode>sample string 9</activationAccessCode>
      <email>sample string 3</email>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <loginStatus>sample string 7</loginStatus>
      <sendActivationEmail>sample string 8</sendActivationEmail>
      <uri>sample string 6</uri>
      <userId>sample string 2</userId>
      <userName>sample string 1</userName>
      <userStatus>sample string 5</userStatus>
      <userType>sample string 4</userType>
    </userInfo>
  </users>
</usersResponse>

}} />