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

API calls for all endpoints tagged UserSocialAccountLogins.

Link to this section Summary

Functions

Deletes user's social account. Deletes a social account from a use's account.

Gets a list of a user's social accounts. Retrieves a list of social accounts linked to a user's account.

Adds social account for a user. Adds a new social account to a user's account.

Link to this section Functions

Link to this function

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

View Source

Specs

user_social_login_delete_user_social_login(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes user's social account. Deletes a social account from a use's account.

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
    • :user_social_account_logins (UserSocialAccountLogins):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets a list of a user's social accounts. Retrieves a list of social accounts linked to a user's account.

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

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

user_social_login_put_user_social_login(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Adds social account for a user. Adds a new social account to a user's account.

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
    • :user_social_account_logins (UserSocialAccountLogins):

Returns

} on success {:error, info} on failure