List users in DSGroup

GET

/v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupId/users

GET

/Management/v2.1/organizations/:organizationId/accounts/:accountId/dsgroups/:dsGroupId/users

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

200Retrieved

{
  "group": {
    "ds_group_id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "source_product_name": "string",
    "group_id": "string",
    "group_name": "string",
    "description": "string",
    "is_admin": true,
    "last_modified_on": "2024-01-15T09:30:00Z",
    "user_count": 1,
    "external_account_id": 1,
    "account_name": "string",
    "is_managed_by_scim": true
  },
  "group_users": {
    "page": 1,
    "page_size": 1,
    "total_count": 1,
    "users": [
      {
        "user_id": "00000000-0000-0000-0000-000000000000",
        "account_id": "00000000-0000-0000-0000-000000000000",
        "user_name": "string",
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string",
        "status": "string",
        "error_details": {
          "error": "string",
          "error_description": "string"
        }
      }
    ]
  }
}

Gets a list of users in a DSGroup.

Required authentication scopes: user_read.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization ID GUID

accountIdstringRequiredformat: "uuid"

The account ID GUID

dsGroupIdstringRequiredformat: "uuid"

The DSGroup's GUID.

Query parameters

pageintegerOptional

Start page of DSGroups.

page_sizeintegerOptional

Page size of DSGroups.

Response

groupobjectOptional

group_usersobjectOptional