Get DS profile for user by email address

GET

/v2.1/organizations/:organizationId/users/dsprofile

GET

/Management/v2.1/organizations/:organizationId/users/dsprofile

curl https://api-d.docusign.net/Management/v2.1/organizations/organizationId/users/dsprofile \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "users": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "site_id": 1,
      "site_name": "string",
      "user_name": "string",
      "first_name": "string",
      "last_name": "string",
      "user_status": "string",
      "default_account_id": "00000000-0000-0000-0000-000000000000",
      "default_account_name": "string",
      "language_culture": "string",
      "selected_languages": "string",
      "federated_status": "string",
      "is_organization_admin": true,
      "created_on": "2024-01-15T09:30:00Z",
      "last_login": "2024-01-15T09:30:00Z",
      "memberships": [
        {
          "email": "string",
          "account_id": "00000000-0000-0000-0000-000000000000",
          "external_account_id": "string",
          "account_name": "string",
          "is_external_account": true,
          "status": "string",
          "permission_profile": {
            "id": 1,
            "name": "string"
          },
          "created_on": "2024-01-15T09:30:00Z",
          "groups": [
            {
              "id": 1,
              "name": "string",
              "type": "string"
            }
          ],
          "is_admin": true,
          "id": "string",
          "license_type": "string",
          "plan_name": "string",
          "subscription_id": "string"
        }
      ],
      "identities": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "provider_id": "00000000-0000-0000-0000-000000000000",
          "user_id": "00000000-0000-0000-0000-000000000000",
          "immutable_id": "string",
          "error_details": {
            "error": "string",
            "error_description": "string"
          }
        }
      ],
      "device_verification_enabled": true,
      "allow_extend_org_admin_rights_to_self": true,
      "allow_two_step_verification_snooze": true,
      "is_managed_by_scim": true,
      "require_two_step_verification": true
    }
  ]
}

Gets information about a user specified by the email query parameter.

Required authentication scopes: user_read.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization's GUID.

Query parameters

emailstringOptional

The email address of the user.

Note: This property is required.

sortbooleanOptional

When true, sorts the results in ascending order by account name.

include_licensebooleanOptional

When true: additional details about the user’s license will be included in the response. The account must have an IAM plan with licenses.

Response

userslist of objectsOptional

A list of users.