DocuSign.Api.CloudStorageProviders (DocuSign v0.3.3) View Source

API calls for all endpoints tagged CloudStorageProviders.

Link to this section Summary

Functions

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.

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.

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.

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.

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.

Link to this section Functions

Link to this function

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

View Source

Specs

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

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.

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 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.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

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.

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 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.
  • opts (KeywordList): [optional] Optional parameters
    • :cloud_storage_providers (CloudStorageProviders):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

cloud_storage_get_cloud_storage(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.CloudStorageProviders.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 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.
  • opts (KeywordList): [optional] Optional parameters
    • :redirect_url (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

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

cloud_storage_get_cloud_storage_providers(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.CloudStorageProviders.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 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.
  • opts (KeywordList): [optional] Optional parameters
    • :redirect_url (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

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

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.

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 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.
  • opts (KeywordList): [optional] Optional parameters
    • :cloud_storage_providers (CloudStorageProviders):

Returns

} on success {:error, info} on failure