Users: updateUser

Required scopes: user_write

Updates a user's information.

Request

HTTP request

POST /v2/organizations/{organizationId}/users/profiles

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Request Body

request

SDK Method

Users::updateUser

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.PermissionProfileRequest

A permission profile.

idinteger

The ID of the profile.

namestring

The name of the profile.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.GroupRequest

A group for a user to belong to.

idinteger

The ID of the group.

namestring

The name of the group.

typestring

The type of group. One of:

  • invalid
  • admin_group
  • everyone_group
  • custom_group

DocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Errors.

errorstring

Short description of the error.

error_descriptionstring

A longer description of the error.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateUsersRequest

A list of users whose information you want to change.

users[DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateUserRequest]

A list of users whose information you want to change.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateUserRequest

Request to change a user's information.

idstring

The user's unique ID.

site_idinteger

The site ID.

user_namestring

The full name of the user.

first_namestring

The user's first name.

last_namestring

The user's last name.

emailstring

The email address

default_account_idstring

The account ID of the user's default account.

language_culturestring

  • Chinese Simplified: zh_CN
  • Chinese Traditional: zh_TW
  • Dutch: nl
  • English: en
  • French: fr
  • German: de
  • Italian: it
  • Japanese: ja
  • Korean: ko
  • Portuguese: pt
  • Portuguese Brazil: pt_BR
  • Russian: ru
  • Spanish: es

federated_statusstring

The user's federated status. One of:

  • RemoveStatus
  • FedAuthRequired
  • FedAuthBypass
  • Evicted

force_password_changeboolean

If true, the user will be required to change the account password.

memberships[DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateMembershipRequest]

A list of group membership requests.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UpdateMembershipRequest

A request to update group membership.

account_idstring

The user's unique ID.

permission_profileDocuSign.API.Organizations.Web.Models.RestApi.v2.Request.PermissionProfileRequest

The user's permission profile.

groups[DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.GroupRequest]

The user's requested groups.

company_namestring

The user's company name.

job_titlestring

The user's job title.

send_activationboolean

If true, send an activation request after the update.

access_codestring

The access code that the user needs to activate an account.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UsersUpdateResponse

Results of changing a user's information.

successboolean

If true, the request to change user information succeeded.

users[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserUpdateResponse]

A list of users whose information could not be changed.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserUpdateResponse

Error result of attempting to change a user's email address.

idstring

The user ID.

site_idinteger

The site ID.

emailstring

The email address

error_detailsDocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Error results.

}} />