Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.

Request

HTTP request

DELETE /v2/accounts/{accountId}/users/{userId}/cloud_storage

Parameters

Parameter name Value Description
Path parameters
accountId string

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

userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

CloudStorage::deleteProviders

Definitions Expand All | Collapse All

CloudStorageProviders

Cloud storage providers

storageProviders
[cloudStorageProvider]

An Array containing the storage providers associated with the user.

cloudStorageProvider

authenticationUrl string

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.

errorDetails errorDetails
redirectUrl string

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.

service string

The service name for the cloud storage provider.

serviceId string

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.

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Request/Response

Request

{
"storageProviders": [
{
"serviceId": "sample string 1",
"service": "sample string 2",
"authenticationUrl": "sample string 3",
"redirectUrl": "sample string 4"
}
]
}

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 Request/Response

Request

<cloudStorageProviders 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<storageProviders>
<cloudStorageProvider>
<authenticationUrl>sample string 3</authenticationUrl>
<redirectUrl>sample string 4</redirectUrl>
<service>sample string 2</service>
<serviceId>sample string 1</serviceId>
</cloudStorageProvider>
</storageProviders>
</cloudStorageProviders>

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>