Users: getUserProfiles

Required scopes: user_read

Returns user information.

Request

HTTP request

GET /v2/organizations/{organizationId}/users/profile

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Optional Query Parameters
emailstring

The email address

SDK Method

Users::getUserProfiles

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.Response.UsersDrilldownResponse

Information about a list of users.

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

A list of users.

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

Information about a user.

idstring

The user's unique ID.

site_idinteger

The site ID of the organization.

site_namestring

The site name of the account.

user_namestring

The full name of the user.

first_namestring

The user's first name.

last_namestring

The user's last name.

user_statusstring

The user's status. One of:

  • active
  • created
  • closed

default_account_idstring

The ID of the user's default account.

default_account_namestring

The name 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

is_organization_adminboolean

If true, the user has organization administration privileges.

created_onstring

The date the user's account was created.

last_loginstring

The date of the last time the user logged in.

memberships[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.MembershipResponse]

A list of organizations that have groups that the user is a member of.

identities[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserIdentityResponse]

A list of identities associated with the user.

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

Information about group membership.

emailstring

The email address

account_idstring

The ID of the account.

external_account_idstring

The external account ID.

account_namestring

The name of the account.

is_external_accountboolean

If true, this is an external account.

statusstring

Status.

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

The user's permission profile.

created_onstring

The date the user's account was created.

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

A list of groups the user is a member of in this account,

is_adminboolean

If true, the user has administration privileges on the account.

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

Results of deleting a user identity.

idstring

The ID of the result.

provider_idstring

The ID of the identity provider.

user_idstring

The user ID.

immutable_idstring

A unique ID to identify the removed user.

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

Error results.

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

Errors.

errorstring

Short description of the error.

error_descriptionstring

A longer description of the error.

}} />