View Source DocuSign.Api.CloudStorageProviders (DocuSign v1.2.0)

API calls for all endpoints tagged CloudStorageProviders.

Summary

Functions

cloud_storage_delete_cloud_storage(connection, account_id, service_id, user_id, opts \\ [])

Deletes the user authentication information for the specified cloud storage provider. 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.

cloud_storage_delete_cloud_storage_providers(connection, account_id, user_id, opts \\ [])

Deletes the user authentication information for one or more cloud storage providers. 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.

cloud_storage_get_cloud_storage(connection, account_id, service_id, user_id, opts \\ [])

Gets the specified Cloud Storage Provider configuration for the User. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

cloud_storage_get_cloud_storage_providers(connection, account_id, user_id, opts \\ [])

Get the Cloud Storage Provider configuration for the specified user. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

cloud_storage_post_cloud_storage(connection, account_id, user_id, opts \\ [])

Configures the redirect URL information for one or more cloud storage providers for the specified user. 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.

Functions

cloud_storage_delete_cloud_storage(connection, account_id, service_id, user_id, opts \\ [])

@spec cloud_storage_delete_cloud_storage(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CloudStorageProviders.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
service_id (String.t): The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters

Returns

{:ok, DocuSign.Model.CloudStorageProviders.t} on success
{:error, Tesla.Env.t} on failure

cloud_storage_delete_cloud_storage_providers(connection, account_id, user_id, opts \\ [])

@spec cloud_storage_delete_cloud_storage_providers(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CloudStorageProviders.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters
- :body (CloudStorageProviders):

Returns

{:ok, DocuSign.Model.CloudStorageProviders.t} on success
{:error, Tesla.Env.t} on failure

cloud_storage_get_cloud_storage(connection, account_id, service_id, user_id, opts \\ [])

@spec cloud_storage_get_cloud_storage(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CloudStorageProviders.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Gets the specified Cloud Storage Provider configuration for the User. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
service_id (String.t): The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136").
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters
- :redirectUrl (String.t): 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.

Returns

{:ok, DocuSign.Model.CloudStorageProviders.t} on success
{:error, Tesla.Env.t} on failure

cloud_storage_get_cloud_storage_providers(connection, account_id, user_id, opts \\ [])

@spec cloud_storage_get_cloud_storage_providers(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CloudStorageProviders.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Get the Cloud Storage Provider configuration for the specified user. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters
- :redirectUrl (String.t): 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.

Returns

{:ok, DocuSign.Model.CloudStorageProviders.t} on success
{:error, Tesla.Env.t} on failure

cloud_storage_post_cloud_storage(connection, account_id, user_id, opts \\ [])

@spec cloud_storage_post_cloud_storage(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CloudStorageProviders.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
user_id (String.t): The ID of the user to access. Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
opts (keyword): Optional parameters
- :body (CloudStorageProviders):

Returns

{:ok, DocuSign.Model.CloudStorageProviders.t} on success
{:error, Tesla.Env.t} on failure