Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.

Request

HTTP request

DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

serviceIdstring

The ID of the service to access.

Valid values are the service name ("Box") or the numerical serviceId ("4136").

userIdstring

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.

Responses

CodeDescriptionReference
200

Successful response.

CloudStorageProviders
400

Error encountered.

errorDetails

SDK Method

CloudStorage::deleteProvider

Definitions

cloudStorageProvider

Contains details about a specific cloud storage provider.

authenticationUrlstring

The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl.

errorDetailserrorDetails

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

redirectUrlstring

The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.

The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.

servicestring

The service name for the cloud storage provider.

serviceIdstring

The DocuSign-generated ID for the cloud storage provider.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

CloudStorageProviders

The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.

storageProviders[cloudStorageProvider]

An Array containing the storage providers associated with the user.

Examples

Generic JSON Response

Response
{
  "storageProviders": [
    {
      "serviceId": "sample string 1",
      "service": "sample string 2",
      "authenticationUrl": "sample string 3",
      "redirectUrl": "sample string 4",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<cloudStorageProviders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <storageProviders>
    <cloudStorageProvider>
      <authenticationUrl>sample string 3</authenticationUrl>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <redirectUrl>sample string 4</redirectUrl>
      <service>sample string 2</service>
      <serviceId>sample string 1</serviceId>
    </cloudStorageProvider>
  </storageProviders>
</cloudStorageProviders> 
}} />