Accounts: getPermissions

Required scopes: permission_read.

Returns the list of permission profiles in an account.

Request

HTTP request

GET /v2/organizations/{organizationId}/accounts/{accountId}/permissions

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

accountIdstring

The account ID Guid

SDK Method

Accounts::getPermissions

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.PermissionsResponse

A list of permission profiles for a given account.

permissions[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.PermissionProfileResponse]

An array of permission profile responses.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.PermissionProfileResponse

This object is an individual permission profile response.

idinteger

The ID of the permission profile. An integer.

namestring

The name of the permission profile. For example, DocuSign Sender

Examples

Generic JSON Response

Response
{
  "permissions": [
    {
      "id": 12424,
      "name": "Account Administrator"
    },
    {
      "id": 12425,
      "name": "DocuSign Sender"
    },
    {
      "id": 12426,
      "name": "DocuSign Viewer"
    }
  ]
}
}} />