Skip to navigation
How-to guides

How to Audit Users

This topic demonstrates how to audit the users in your account by retrieving the profiles of users that were modified after a specified date.
View as Markdown

This topic demonstrates how to audit the users in your account by retrieving the profiles of users that were modified after a specified date.

Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.

Required data

Running the code in this how-to requires this data:

Data elementDescription
{API_ACCOUNT_ID}A GUID value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field on the Apps and Keys page.
Admin accessThe caller must be an eSignature account administrator.
{BASE_PATH}A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at
https://<domain>/management
Where <domain> is api-d.docusign.net for the developer environment and api.docusign.net for production.
{ORGANIZATION_ID}A GUID value that identifies the the organization that contains the account to which the user will be added. Copy the value from the Organization ID field in the Organization section of the Account Profile page.

Step 1. Obtain your OAuth token

To make the API calls shown in this how-to, you need a valid OAuth access token. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario.

Docusign Admin OAuth access tokens are the same ones used for our eSignature REST API, although you must request one or more Docusign Admin scopes to call the Docusign Admin API. The endpoint calls made in this how-to require that you request the Docusign Admin-specific user_write scope when obtaining your access token.

See Docusign Admin Authentication for details and the full list of Docusign Admin scopes.

Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant

Step 2. Construct your API headers

After you have a valid OAuth access token, you are ready to construct the API headers that you will pass to the API call. Construct your headers like this, but make sure to substitute your valid OAuth access token for {ACCESS_TOKEN}.

declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \
    '--header' "Accept: application/json" \
    '--header' "Content-Type: application/json")

Step 3. Get a list of modified users

Now that you have constructed your API headers, make a GET request to the Admin API to retrieve the recently modified users in your account. Here’s how you make the call, but make sure to substitute your API account ID for {ACCOUNT_ID} and your organization ID for {ORGANIZATION_ID}.

# Calculate date parameter to get users modified in the last 10 days
if date -v -10d &>/dev/null; then
    # Mac
    # modified_since=`date -v -10d '+%Y-%m-%dT%H:%M:%S%z'`
    modified_since=$(date -v -10d '+%Y-%m-%d')
else
    # Not a Mac
    # modified_since=`date --date='-10 days' '+%Y-%m-%dT%H:%M:%S%z'`
    modified_since=$(date --date='-10 days' '+%Y-%m-%d')
fi
response=$(mktemp /tmp/response-admin.XXXXXX)
# Call the Admin API
Status=$(
    curl -w '%{http_code}' --request GET "${base_path}/v2/organizations/${ORGANIZATION_ID}/users?account_id=${API_ACCOUNT_ID}&last_modified_since${modified_since}" \
    "${Headers[@]}" \
    --output $response
)

Step 4. Get the email addresses of the modified users

To get the profile of each modified user you will need to extract the email address of each user from the list of users returned in Step 3. The accompanying code demonstrates how to build a list of email addresses to be passed as parameters in your calls to eSignUserManagement:getUserProfiles.

modified_users=$(cat $response)
user_emails=`echo $modified_users | grep -o -P '(?<=email\":\").*?(?=\")'`
array_emails=($user_emails)

Step 5. Call the Docusign Admin API

Using your list of user email addresses from Step 4, call the Admin API to get the user profile for the user associated with each email address. Here’s how you make the call, but make sure to substitute your organization ID for {ORGANIZATION_ID}.

View the source code for this how-to on GitHub: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby

profiles=$(mktemp /tmp/profiles-oa.XXXXXX)
echo ''
echo 'User profiles:'
for email in ${array_emails[@]}
do
    Status=$(
        curl -w '%{http_code}' -i --request GET "${base_path}/v2/organizations/${ORGANIZATION_ID}/users/profile?email=${email}" \
        "${Headers[@]}" \
        --output ${profiles}
    )
    echo ''
    cat $profiles
    echo ''
done

Expected response

If your API call is successful, you should see a JSON response similar to this for each user.

Sample response
{
  "users": [
    {
      "id": "f5963dc2-xxxx-xxxx-xxxx-76d362ecaa40",
      "site_id": 1,
      "site_name": "Demo",
      "user_name": "User Name",
      "first_name": "User",
      "last_name": "Name",
      "user_status": "active",
      "default_account_id": "f7802c14-xxxx-xxxx-xxxx-65244a0dd179",
      "default_account_name": "DocuSign",
      "language_culture": "en",
      "is_organization_admin": true,
      "created_on": "2020-09-21T18:21:51.623",
      "memberships": [
        {
          "email": "1007a@example.com",
          "account_id": "f7802c14-xxxx-xxxx-xxxx-65244a0dd179",
          "external_account_id": "11xxxx42",
          "account_name": "DocuSign",
          "is_external_account": false,
          "status": "active",
          "permission_profile": {
            "id": 10xxxx51,
            "name": "Account Administrator"
          },
          "created_on": "2020-09-21T18:21:51.623",
          "groups": [
            {
              "id": 76xxx01,
              "name": "Administrators",
              "type": 1
            },
            {
              "id": 76xxx02,
              "name": "Everyone",
              "type": 2
            }
          ],
          "is_admin": true
        }
      ],
      "identities": [],
      "device_verification_enabled": true
    }
  ]
}

Next steps