Users: addUsers

Required scopes: user_write

Adds users to an account.

Request

HTTP request

POST /v2/organizations/{organizationId}/accounts/{accountId}/users

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

accountIdstring

The account ID Guid

Request Body

request

SDK Method

Users::addUsers

Definitions

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

This object is an individual permission profile response.

idinteger

The ID of the permission profile. An integer.

namestring

The name of the permission profile. For example, DocuSign Sender

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

And individual group responses,.

idinteger

The unique 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.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.v2.Response.NewUserResponse

Information about a newly created user.

idstring

The unique ID of the user.

site_idinteger

The user's 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

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

accounts[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.NewUserResponseAccountProperties]

A list of accounts the user belongs to.

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

Information about a newly created user.

idstring

The user's unique ID.

site_idinteger

The site ID of the account.

permission_profileDocuSign.API.Organizations.Web.Models.RestApi.v2.Response.PermissionProfileResponse

The user's permission profile.

groups[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.MemberGroupResponse]

A list of groups that the user belongs to.

company_namestring

The user's company name.

job_titlestring

The user's job title.

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

A new user request.

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

The new user's permission profile.

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

The new user's requested groups.

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

access_codestring

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

federated_statusstring

The user's federated status. One of:

  • RemoveStatus
  • FedAuthRequired
  • FedAuthBypass
  • Evicted

auto_activate_membershipsboolean

If true, the user's account is activated automatically.

}} />