Skip to content

DocuSign: Retrieves the DS profile for a user specified by ID

DocuSign admin.adminOrganizationUserOrganizationUsersGetDsprofileByUserId: arguments, response, policy and SDK examples.

← Admin operations · Get started

Operation docusign.admin_organizationuser_organizationusers_getdsprofilebyuserid

Provider route: GET /Management/v2.1/organizations/{organizationId}/users/{userId}/dsprofile. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["admin"]["adminOrganizationUserOrganizationUsersGetDsprofileByUserId"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.admin.adminOrganizationUserOrganizationUsersGetDsprofileByUserId(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.admin.admin_organization_user_organization_users_get_dsprofile_by_user_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.organizationIdstringRequired within parentFormat: uuid
path.userIdstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.sortbooleanOptional
query.include_licensebooleanOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieves the DS profile for a user specified by ID — response body

Referenced models: Retrieves the DS profile for a user specified by ID — response body

Retrieves the DS profile for a user specified by ID — response body
FieldTypePresenceDescription and constraints
$objectRootInformation about a list of users.
usersarrayOptionalA list of users.
users[]ModelEach itemExpand Retrieves the DS profile for a user specified by ID — response body — users item

Referenced models: Retrieves the DS profile for a user specified by ID — response body — users item

Retrieves the DS profile for a user specified by ID — response body — users item
FieldTypePresenceDescription and constraints
$objectRootInformation about a user.
allow_extend_org_admin_rights_to_selfbooleanOptional
allow_two_step_verification_snoozebooleanOptional
created_onstringOptionalThe date the user's account was created.
Format: date-time
default_account_idstringOptionalThe ID of the user's default account.
Format: uuid
default_account_namestringOptionalThe name of the user's default account.
device_verification_enabledbooleanOptional
federated_statusstringOptionalThe user's federated status. One of:

- `RemoveStatus`
- `FedAuthRequired`
- `FedAuthBypass`
- `Evicted`
first_namestringOptionalThe user's first name.
idstringOptionalThe user's unique ID.
Format: uuid
identitiesarrayOptionalA list of identities associated with the user.
identities[]ModelEach itemExpand Delete user identities for a specified identity provider — response body — identities item
is_managed_by_scimbooleanOptional
is_organization_adminbooleanOptionalWhen **true,** the user has organization administration privileges.
language_culturestringOptionalThe language and culture of the user.

* 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`
last_loginstringOptionalThis property has been deprecated.
Format: date-time
last_namestringOptionalThe user's last name.
membershipsarrayOptionalA list of organizations that have groups that the user is a member of.
memberships[]ModelEach itemExpand Retrieves the DS profile for a user specified by ID — response body — users item memberships item
require_two_step_verificationbooleanOptional
selected_languagesstringOptional
site_idJSONOptional
site_id (anyOf 1)integerAlternativeThe site ID of the organization.
Format: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
site_namestringOptionalThe site name of the account.
user_namestringOptionalThe full name of the user.
user_statusstringOptionalThe user's status. One of:

- `active`
- `created`
- `closed`

Referenced models: Retrieves the DS profile for a user specified by ID — response body — users item memberships item, Delete user identities for a specified identity provider — response body — identities item

Retrieves the DS profile for a user specified by ID — response body — users item memberships item
FieldTypePresenceDescription and constraints
$objectRootInformation about group membership.
account_idstringOptionalThe ID of the account.
Format: uuid
account_namestringOptionalThe name of the account.
created_onstringOptionalThe date the user's account was created.
Format: date-time
emailstringOptionalThe email address.
external_account_idstringOptionalThe external account ID.
groupsarrayOptionalA list of groups the user is a member of in this account,
groups[]ModelEach itemExpand Returns the list of groups in an account — response body — groups item
idstringOptionalFormat: uuid
is_adminbooleanOptionalWhen **true,**
the user has administration
privileges on the account.
is_external_accountbooleanOptionalWhen **true,**
this is an external account.
license_typestringOptional
permission_profileModelOptionalExpand Returns the list of permission profiles in an account — response body — permissions item
The user's permission profile.
plan_namestringOptional
statusstringOptionalThe status of the user's membership.
subscription_idstringOptional

Referenced models: Returns the list of groups in an account — response body — groups item, Returns the list of permission profiles in an account — response body — permissions item

Delete user identities for a specified identity provider — response body — identities item
FieldTypePresenceDescription and constraints
$objectRootResults of deleting a user identity.
error_detailsModelOptionalExpand Updates a user's email address — response body — users item error details
Error results.
idstringOptionalThe ID of the result.
Format: uuid
immutable_idstringOptionalA unique ID to identify the removed user.
provider_idstringOptionalThe ID of the identity provider.
Format: uuid
user_idstringOptionalThe user ID.
Format: uuid

Referenced models: Updates a user's email address — response body — users item error details

Returns the list of groups in an account — response body — groups item
FieldTypePresenceDescription and constraints
$objectRootAnd individual group responses,.
idJSONOptional
id (anyOf 1)integerAlternativeThe unique ID of the group.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the group.
typestringOptionalThe type of group. One of:

- `invalid`
- `admin_group`
- `everyone_group`
- `custom_group`
Returns the list of permission profiles in an account — response body — permissions item
FieldTypePresenceDescription and constraints
$objectRootThis object is an individual permission profile response.
idJSONOptional
id (anyOf 1)integerAlternativeThe ID of the permission profile.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the permission profile.

Example: `DocuSign Sender`
Updates a user's email address — response body — users item error details
FieldTypePresenceDescription and constraints
$objectRootErrors.
errorstringOptionalThe code for the error.
error_descriptionstringOptionalA description of the error.

SDK function policy ID: docusign.admin_organizationuser_organizationusers_getdsprofilebyuserid. Catalog operation: admin:OrganizationUser_OrganizationUsers_GetDSProfileByUserId. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["user_read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.