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

API calls for all endpoints tagged UserProfiles.

Summary

Functions

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

Retrieves the user profile for a specified user. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

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

Updates the user profile information for the specified user. Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the userDetails property. When changing a user's name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence over changes to the userName property.

Functions

Link to this function

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

View Source 
@spec user_profile_get_profile(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.UserProfile.t()}
  | {:error, Tesla.Env.t()}

Retrieves the user profile for a specified user. Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified 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 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.UserProfile.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

View Source 
@spec user_profile_put_profile(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Updates the user profile information for the specified user. Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user's name by changing the information in the userDetails property. When changing a user's name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence over changes to the userName property.

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 (UserProfile):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure