DocuSign.Api.Authentication.login_information_get_login_information

You're seeing just the function login_information_get_login_information, go back to DocuSign.Api.Authentication module for more information.
Link to this function

login_information_get_login_information(connection, opts \\ [])

View Source

Specs

login_information_get_login_information(Tesla.Env.client(), keyword()) ::
  {:ok, DocuSign.Model.Authentication.t()} | {:error, Tesla.Env.t()}

Gets login information for a specified user. Retrieves account information for the authenticated user. Since the API is sessionless, this method does not actually log you in. Instead, the method returns information about the account or accounts that the authenticated user has access to. ###### Important: This method must only be used for the [Legacy Header Authentication][legacyheader] flow. Use the `AccountServer: userInfo` method for the OAuth2 Authentiction Code and Implicit Grant flows. Each account has a `baseUrl` property, returned in the response. Use this `baseUrl` in all future API calls as the base of the request URL. For each account, the `baseUrl` property includes the DocuSign server, the API version, and the `accountId` property. It is not uncommon for an authenticated user to have access to more than one account (and more than one `baseUrl`). Depending on your integration's use case, your integration may choose to: Use the account whose `isDefault` field is `true`. List the available accounts and ask the user to choose one. * Enable the system administrator to set the account that should be used by your integration. If this method returns successfully, then you also know that the user has successfully authenticated with the DocuSign Signature platform. [legacyheader]: ../../../../guides/authentication/legacy [userinfo]: ../../../../guides/authentication/user-info-endpoints [authcode]: ../../../../guides/authentication/oauth2-code-grant [implicit]: ../../../../guides/authentication/oauth2-implicit

Parameters

  • connection (DocuSign.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :api_password (String.t): Reserved for DocuSign.
    • :embed_account_id_guid (String.t):
    • :include_account_id_guid (String.t): When set to true, shows the account ID GUID in the response.
    • :login_settings (String.t): Determines whether login settings are returned in the response. Valid Values: all - All the login settings are returned. none - no login settings are returned.

Returns

} on success {:error, info} on failure