Get Admin Groups

Gets a collection of user groups

GET /platform/adminuser/groups

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "description": "<string>",
      "groupCode": "<string>",
      "name": "<string>",
      "scopeId": 123,
      "scopeTypeId": 123,
      "users": [
        {
          "emailAddress": "<string>",
          "externalId": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "identityProviderId": "<string>",
          "isActive": true,
          "lastName": "<string>",
          "localeCode": "<string>",
          "optInToEmail": true,
          "optInToTextMessage": true,
          "password": "<string>",
          "phoneNumber": "<string>",
          "roles": [
            {
              "assignedInScope": {
                "id": 123,
                "name": "<string>",
                "type": "<string>"
              },
              "auditInfo": {
                "createBy": "<string>",
                "createDate": "2023-11-07T05:31:56Z",
                "updateBy": "<string>",
                "updateDate": "2023-11-07T05:31:56Z"
              },
              "roleId": 123,
              "roleName": "<string>",
              "roleResources": [
                {
                  "id": "<string>",
                  "type": "<string>"
                }
              ],
              "roleTags": [
                "<string>"
              ],
              "userId": "<string>"
            }
          ],
          "systemData": {
            "createdOn": "2023-11-07T05:31:56Z",
            "failedLoginAttemptCount": 123,
            "firstFailedLoginAttemptOn": "2023-11-07T05:31:56Z",
            "isLocked": true,
            "isPasswordChangeRequired": true,
            "lastLockedOn": "2023-11-07T05:31:56Z",
            "lastLoginOn": "2023-11-07T05:31:56Z",
            "lastPasswordChangeOn": "2023-11-07T05:31:56Z",
            "remainingLoginAttempts": 123,
            "updatedOn": "2023-11-07T05:31:56Z"
          },
          "userName": "<string>"
        }
      ]
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

pageSize · integer<int32> · default: 100

sortBy · string

filter · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>