DIdigicert
accessmanagement - user groups

Lists the non-members of a specific user group.

This endpoint lists the users not currently assigned to a specific user group, helping users identify candidates for group membership.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns 400 and 404 error codes with clear descriptions when requests fail.</br>- Dynamic filtering: Uses the type parameter to filter results, streamlining access to specific users and enhancing data retrieval efficiency.</br>- Search term filtering: Uses the searchTerm parameter to filter results by matching user usernames or email addresses, enabling quick and precise user lookup.</br>- Targeted data retrieval: Employs the userGroupId parameter to return the specified user group's first 500 non-members, ensuring accuracy and relevance in the response.

get/accessmanagement/usergroups/{userGroupId}/nonmembers

Request

Path parameters

userGroupIdinteger required

Filters data by the user group’s unique identifier.

Query parameters

searchTermstring

Filters users by username or email address.

type'user' | 'service'

Filters users by type

Response

Non-members listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 9,
      "userId": 11,
      "name": "user3",
      "email": "user3@test1.com",
      "username": "user3",
      "canDelete": true
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.