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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organizationId | string | Required within parent | Format: uuid |
path.userId | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.sort | boolean | Optional | |
query.include_license | boolean | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”Retrieves the DS profile for a user specified by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a list of users. |
users | array | Optional | A list of users. |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a user. |
allow_extend_org_admin_rights_to_self | boolean | Optional | |
allow_two_step_verification_snooze | boolean | Optional | |
created_on | string | Optional | The date the user's account was created. Format: date-time |
default_account_id | string | Optional | The ID of the user's default account. Format: uuid |
default_account_name | string | Optional | The name of the user's default account. |
device_verification_enabled | boolean | Optional | |
federated_status | string | Optional | The user's federated status. One of: - `RemoveStatus` - `FedAuthRequired` - `FedAuthBypass` - `Evicted` |
first_name | string | Optional | The user's first name. |
id | string | Optional | The user's unique ID. Format: uuid |
identities | array | Optional | A list of identities associated with the user. |
identities[] | Model | Each item | Expand Delete user identities for a specified identity provider — response body — identities item |
is_managed_by_scim | boolean | Optional | |
is_organization_admin | boolean | Optional | When **true,** the user has organization administration privileges. |
language_culture | string | Optional | The 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_login | string | Optional | This property has been deprecated. Format: date-time |
last_name | string | Optional | The user's last name. |
memberships | array | Optional | A list of organizations that have groups that the user is a member of. |
memberships[] | Model | Each item | Expand Retrieves the DS profile for a user specified by ID — response body — users item memberships item |
require_two_step_verification | boolean | Optional | |
selected_languages | string | Optional | |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | The site ID of the organization. Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
site_name | string | Optional | The site name of the account. |
user_name | string | Optional | The full name of the user. |
user_status | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about group membership. |
account_id | string | Optional | The ID of the account. Format: uuid |
account_name | string | Optional | The name of the account. |
created_on | string | Optional | The date the user's account was created. Format: date-time |
email | string | Optional | The email address. |
external_account_id | string | Optional | The external account ID. |
groups | array | Optional | A list of groups the user is a member of in this account, |
groups[] | Model | Each item | Expand Returns the list of groups in an account — response body — groups item |
id | string | Optional | Format: uuid |
is_admin | boolean | Optional | When **true,** the user has administration privileges on the account. |
is_external_account | boolean | Optional | When **true,** this is an external account. |
license_type | string | Optional | |
permission_profile | Model | Optional | Expand Returns the list of permission profiles in an account — response body — permissions item The user's permission profile. |
plan_name | string | Optional | |
status | string | Optional | The status of the user's membership. |
subscription_id | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results of deleting a user identity. |
error_details | Model | Optional | Expand Updates a user's email address — response body — users item error details Error results. |
id | string | Optional | The ID of the result. Format: uuid |
immutable_id | string | Optional | A unique ID to identify the removed user. |
provider_id | string | Optional | The ID of the identity provider. Format: uuid |
user_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | And individual group responses,. |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | The unique ID of the group. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the group. |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is an individual permission profile response. |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | The ID of the permission profile. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the permission profile. Example: `DocuSign Sender` |
Updates a user's email address — response body — users item error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Errors. |
error | string | Optional | The code for the error. |
error_description | string | Optional | A description of the error. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]