Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

userIdstring

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. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

Responses

CodeDescriptionReference
201

Successful response.

CloudStorageProviders
400

Error encountered.

errorDetails

SDK Method

CloudStorage::createProvider

Definitions

cloudStorageProvider

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

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

An error code associated with the error.

messagestring

A short error message.

CloudStorageProviders

Cloud storage providers

storageProviders[cloudStorageProvider]

An Array containing the storage providers associated with the user.

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> 
}} />