> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# How to set up a permission profile

> Demonstrates how to set a user group’s permission profile with the eSignature REST API

This topic demonstrates how to set a group’s permission profile with the eSignature REST API.

> **Note**
>
> Run this code example from our [Quickstart](/docs/esign-rest-api/quickstart) or launcher projects: [Bash](https://github.com/docusign/code-examples-bash), [C#](https://github.com/docusign/code-examples-csharp), [Java](https://github.com/docusign/code-examples-java), [Node.js](https://github.com/docusign/code-examples-node), [PHP](https://github.com/docusign/code-examples-php), [PowerShell](https://github.com/docusign/code-examples-powershell), [Python](https://github.com/docusign/code-examples-python), or [Ruby](https://github.com/docusign/code-examples-ruby).

## Required data

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

| Data element             | Description                                                                                                                                                                                                                                                                                                            |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \{API_ACCOUNT_ID}        | A [GUID](http://guid.one/) 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](https://admindemo.docusign.com/authenticate?goTo=appsAndKeys) page.                               |
| \{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>/restapi Where \<domain> is demo.docusign.net for the developer environment and is the result of the GetUserInfo call in production. |
| \{GROUP_ID}              | A string value that identifies a given [user group](https://support.docusign.com/s/document-item?language=en_US\&bundleId=pik1583277475390\&topicId=cuv1583277363488.html). This value is automatically generated by Docusign for any user group you create.                                                           |
| \{PERMISSION_PROFILE_ID} | A string value that identifies your [permission profile](/docs/esign-rest-api/esign101/concepts/permissions). This value is automatically generated by Docusign for any permission profile you create.                                                                                                                 |

## Step 1. Obtain your OAuth token

To make the API call 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.

> **Note**
>
> See [Confidential Authorization Code Grant](/platform/auth/authcode#confidential-authorization-code-grant) for guidance on your options to get an Confidential Authorization Code Grant  OAuth token.

![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](/_fern-files/_img/64f473773042ee439449a096bf7673292b1585b86a4ccc55f82ba0dda41f61a1.webp)

## 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}.

**`Bash`**

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

**`C#`**

```csharp title="C#"
var docuSignClient = new DocuSignClient(basePath);
docuSignClient.Configuration.DefaultHeader.Add("Authorization", "Bearer " + accessToken);
```

**`Java`**

```java title="Java"
ApiClient apiClient = new ApiClient(basePath);
apiClient.addDefaultHeader(HttpHeaders.AUTHORIZATION, BEARER_AUTHENTICATION + userAccessToken);
```

**`Node.js`**

```javascript title="Node.js"
let dsApiClient = new docusign.ApiClient();
dsApiClient.setBasePath(args.basePath);
dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);
let groupApi = new docusign.GroupsApi(dsApiClient);
```

**`PHP`**

```php title="PHP"
$config = new Configuration();
$config->setHost($args['base_path']);
$config->addDefaultHeader('Authorization', 'Bearer ' . $args['ds_access_token']);
$this->apiClient = new ApiClient($config);
```

**`PowerShell`**

```text title="PowerShell"
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.add("Authorization", "Bearer $oAuthAccessToken")
$headers.add("Accept", "application/json")
$headers.add("Content-Type", "application/json")
```

**`Python`**

```python title="Python"
api_client = create_api_client(base_path=args["base_path"], access_token=args["access_token"])
group_api = GroupsApi(api_client)
```

**`Ruby`**

```ruby title="Ruby"
configuration = DocuSign_eSign::Configuration.new
configuration.host = args[:base_path]
api_client = DocuSign_eSign::ApiClient.new configuration

api_client.default_headers['Authorization'] = "Bearer #{args[:access_token]}"
```

## Step 3. Construct the request body

Next, create the request body, substituting your permission profile ID for \{PROFILE_ID} and the group ID for \{GROUP_ID}:

**`Bash`**

```bash title="Bash"
request_data=$(mktemp /tmp/request-perm-001.XXXXXX)
printf \
'{
    "groups": [
        {
            "groupId": "'"${group_id}"'",
            "permissionProfileId": "'"${profile_id}"'" 
        }
            ]
}' >> $request_data
```

**`C#`**

```csharp title="C#"
var editedGroup = new Group
{
    GroupId = userGroupId,
    PermissionProfileId = permissionProfileId,
};
var requestBody = new GroupInformation { Groups = new List<Group> { editedGroup } };
```

**`Java`**

```java title="Java"
GroupInformation newGroupInfo = PermissionSetUserGroupsService.permissionSetUserGroups(
        apiClient,
        args.getGroupId(),
        args.getProfileId(),
        session.getAccountId()
);
```

**`Node.js`**

```javascript title="Node.js"
const requestBody = {
  groupInformation: {
    groups: [
      {
        permissionProfileId: args.permissionProfileId,
        groupId: args.userGroupId,
      },
    ],
  },
};
```

**`PHP`**

```php title="PHP"
$groups_api = $clientService->getGroupsApi();
$group = new Group($args['permission_args']);
$group_information = new GroupInformation(['groups' => [$group]]);
```

**`PowerShell`**

```text title="PowerShell"
$body = @"
{
    "groups": [
        {
            "groupName": "${GROUP_NAME}",
        }
    ]
}
"@
```

**`Python`**

```python title="Python"
group = Group(group_id=args["group_id"], permission_profile_id=args["permission_profile_id"])
group_information = GroupInformation(groups=[group])
```

**`Ruby`**

```ruby title="Ruby"
params = { groups: [{ permissionProfileId: args[:permission_profile_id], groupId: args[:group_id] }] }
```

## Step 4. Call the eSignature REST API

Now that you have constructed your request body, make a POST request to the [AccountPermissionProfiles:update](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/update) endpoint and include the request body to assign the permission profile to your group.

Here’s how you make the call, but make sure to substitute your API account ID for \{API_ACCOUNT_ID} and your profile ID for \{PROFILE_ID}:

> **Note**
>
> View the source code for this how-to on GitHub: [Bash](https://github.com/docusign/code-examples-bash/blob/master/examples/eSignature/eg025SettingPermissionProfiles.sh), [C#](https://github.com/docusign/code-examples-csharp/blob/master/launcher-csharp/eSignature/Examples/SetUserGroupPermission.cs), [Node.js](https://github.com/docusign/code-examples-node/blob/master/lib/eSignature/examples/permissionSetUserGroup.js), [Java](https://github.com/docusign/code-examples-java/blob/master/src/main/java/com/docusign/controller/eSignature/examples/EG025ControllerPermissionSetUserGroups.java), [PHP](https://github.com/docusign/code-examples-php/blob/master/src/Services/Examples/eSignature/PermissionSetUserGroupService.php), [PowerShell](https://github.com/docusign/code-examples-powershell/blob/master/examples/eSignature/eg025SettingPermissionProfiles.ps1), [Python](https://github.com/docusign/code-examples-python/blob/master/app/eSignature/examples/eg025_permissions_set_user_group.py), or [Ruby](https://github.com/docusign/code-examples-ruby/blob/main/app/services/e_sign/eg025_permissions_set_user_group_service.rb)

**`Bash`**

```bash title="Bash"
Status=$(curl -w '%{http_code}' -i --request PUT ${base_path}/v2.1/accounts/${account_id}/groups \
     "${Headers[@]}" \
     --data-binary @${request_data} \
     --output ${response})
```

**`C#`**

```csharp title="C#"
var updateGroupsResponse = groupsApi.UpdateGroupsWithHttpInfo(accountId, requestBody);
updateGroupsResponse.Headers.TryGetValue("X-RateLimit-Remaining", out string remaining);
updateGroupsResponse.Headers.TryGetValue("X-RateLimit-Reset", out string reset);

if (reset != null && remaining != null)
{
    DateTime resetDate = DateTimeOffset.FromUnixTimeSeconds(long.Parse(reset)).UtcDateTime;
    Console.WriteLine("API calls remaining: " + remaining);
    Console.WriteLine("Next Reset: " + resetDate);
}

return updateGroupsResponse.Data;
```

**`Java`**

```java title="Java"
GroupsApi groupsApi = new GroupsApi(accountsApi.getApiClient());
var groupInformation = groupsApi.listGroupsWithHttpInfo(accountId, groupsApi.new ListGroupsOptions());
headers = groupInformation.getHeaders();
remaining = headers.get("X-RateLimit-Remaining");
reset = headers.get("X-RateLimit-Reset");

if (remaining != null & reset != null) {
    Instant resetInstant = Instant.ofEpochSecond(Long.parseLong(reset.get(0)));
    System.out.println("API calls remaining: " + remaining);
    System.out.println("Next Reset: " + resetInstant);
}
model.addAttribute(MODEL_LIST_GROUPS, groupInformation.getData().getGroups());
```

**`Node.js`**

```javascript title="Node.js"
let results = await groupApi.updateGroups(args.accountId, requestBody, (error, data, response) => {
    const headers = response?.headers;

    const remaining = headers?.['x-ratelimit-remaining'];
    const reset = headers?.['x-ratelimit-reset'];

    if (remaining && reset) {
      const resetInstant = new Date(Number(reset) * 1000);

      console.log(`API calls remaining: ${remaining}`);
      console.log(`Next Reset: ${resetInstant.toISOString()}`);
    }
});
```

**`PHP`**

```php title="PHP"
$updatedGroups = $groups_api->updateGroupsWithHttpInfo(
    $args['account_id'],
    $group_information
);

$remaining = $updatedGroups[2]['X-RateLimit-Remaining'] ?? null;
$reset =  $updatedGroups[2]['X-RateLimit-Reset'] ?? null;

if ($remaining !== null && $reset !== null) {
    $resetInstant = (new DateTime())->setTimestamp((int)$reset);
    error_log("API calls remaining: $remaining");
    error_log("Next Reset: " . $resetInstant->format(\DateTime::ATOM));
}
```

**`PowerShell`**

```text title="PowerShell"
$uri = "https://demo.docusign.net/restapi/v2.1/accounts/$APIAccountId/groups"
$response = $null

try {
    Write-Output "Response:"
    $response = Invoke-WebRequest -uri $uri -headers $headers -body $body -method PUT
    $response.Content
}
catch {
    Write-Output "Unable to set permissions profile to group."
    # On failure, display a notification, X-DocuSign-TraceToken, error message, and the command that triggered the error
    foreach ($header in $_.Exception.Response.Headers) {
        if ($header -eq "X-DocuSign-TraceToken") { Write-Output "TraceToken : " $_.Exception.Response.Headers[$int] }
        $int++
    }
    Write-Output "Error : "$_.ErrorDetails.Message
    Write-Output "Command : "$_.InvocationInfo.Line
}
```

**`Python`**

```python title="Python"
(response, status, headers) = group_api.update_groups_with_http_info(account_id=args["account_id"], group_information=group_information)

remaining = headers.get("X-RateLimit-Remaining")
reset = headers.get("X-RateLimit-Reset")

if remaining is not None and reset is not None:
    reset_date = dt.fromtimestamp(int(reset), tz=timezone.utc)
    print(f"API calls remaining: {remaining}")
    print(f"Next Reset: {reset_date}")
```

**`Ruby`**

```ruby title="Ruby"
results, _status, headers = group_api.update_groups_with_http_info(args[:account_id], params)

remaining = headers['X-RateLimit-Remaining']
reset = headers['X-RateLimit-Reset']

if remaining && reset
  reset_date = Time.at(reset.to_i).utc
  puts "API calls remaining: #{remaining}"
  puts "Next Reset: #{reset_date}"
end
```

## Expected response

If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to the code shown.

**`Sample response`**

```json title="Sample response"
{
  "groups":
  [
    {
      "groupId": "7xxxxx4",
      "groupName": "Test1",
      "permissionProfileId": "10xxxx46",
      "groupType": "customGroup"
    }
  ]
}
```

## Next steps

* Run this code example from our [Quickstart](/docs/esign-rest-api/quickstart) or launcher projects:    [Bash](https://github.com/docusign/code-examples-bash), [C#](https://github.com/docusign/code-examples-csharp), [Java](https://github.com/docusign/code-examples-java), [Node.js](https://github.com/docusign/code-examples-node), [PHP](https://github.com/docusign/code-examples-php), [PowerShell](https://github.com/docusign/code-examples-powershell), [Python](https://github.com/docusign/code-examples-python), or [Ruby](https://github.com/docusign/code-examples-ruby).
* See all available eSignature [How-to guides](/docs/esign-rest-api/how-to).
* See [permission profiles](/docs/esign-rest-api/esign101/concepts/permissions)  for more information.
* See how to [Go-Live](/docs/esign-rest-api/go-live) with a completed app and find the base path for API calls in the production environment.