How to delete user product permission profiles using an email address

This topic demonstrates how to list and delete Docusign Admin user product permission profiles.

Required data

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

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.

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. Retrieve user product permission profiles

Make a GET request to the MultiProductUserManagement:getUserProductPermissionProfilesByEmail endpoint to retrieve the product permission profiles associated with a user email address.

Here’s how you make the call, but make sure to substitute your organization ID for {ORGANIZATION_ID}, your API account ID for {API_ACCOUNT_ID}, and the desired email address for {EMAIL_ADDRESS}.

curl --request GET ${base_path}/v2.1/organizations/${ORGANIZATION_ID}/accounts/${API_ACCOUNT_ID}/products/permission_profiles/users?email=${EMAIL_ADDRESS} \
    "${Headers[@]}" \
    --output ${response}

Step 4. Create the request body

To delete a user product permission profile, construct your request body as shown.

Make sure to substitute the desired email address for {EMAIL_ADDRESS} and the product ID associated with the permission profile you wish to delete for {PRODUCT_ID}. These values can be taken from the response of the previous step.

printf \
'{
  "user_email": "'${EMAIL_ADDRESS}'",
  "product_ids": [
    "'${PRODUCT_ID}'",
  ]
}
' >>$request_data

Step 5. Call the Docusign Admin API

Now that you have constructed your request body, make a DELETE request to the MultiProductUserManagement:removeUserProductPermission endpoint to delete a product permission profile from the specified user. Please read the warning about using this endpoint.

Here’s how you make the call, but make sure to substitute your base path for {BASE_PATH}, your API account ID for {API_ACCOUNT_ID}, and your organization ID for {ORGANIZATION_ID}.

curl -w '%{http_code}' -i --request DELETE "${base_path}/v2.1/organizations/${ORGANIZATION_ID}/accounts/${API_ACCOUNT_ID}/products/users" \
  "${Headers[@]}" \
  --data-binary @${request_data} \
  --output ${response}

Expected response

If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to “Sample successful response”. “Sample failed response” is shown in the second gist tab.

{
  "is_success":true,
  "user_email":"example@example.com",
  "user_product_results":
  {
    "37f013eb-7012-4588-8028-357b39fdbd00":"deleted"
  }
}

Next steps

• Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PHP, PowerShell, Python, or Ruby.
• See all available Admin API How-to guides.
• See How to create a new active user for CLM and eSignature.
• See How to update user product permission profiles using an email address.
• See how to Go-Live with a completed app and find the base path for API calls in the production environment.