Skip to main content
PUT
/
platform
/
adminuser
/
groups
/
{groupCode}
Error
A valid request URL is required to generate request examples
{
  "groupCode": "<string>",
  "scopeTypeId": 123,
  "scopeId": 123,
  "name": "<string>",
  "description": "<string>",
  "users": [
    {
      "emailAddress": "<string>",
      "userName": "<string>",
      "phoneNumber": "<string>",
      "externalId": "<string>",
      "localeCode": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "password": "<string>",
      "optInToEmail": true,
      "optInToTextMessage": true,
      "id": "<string>",
      "systemData": {
        "isPasswordChangeRequired": true,
        "lastPasswordChangeOn": "2023-11-07T05:31:56Z",
        "isLocked": true,
        "lastLockedOn": "2023-11-07T05:31:56Z",
        "failedLoginAttemptCount": 123,
        "remainingLoginAttempts": 123,
        "firstFailedLoginAttemptOn": "2023-11-07T05:31:56Z",
        "lastLoginOn": "2023-11-07T05:31:56Z",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z"
      },
      "roles": [
        {
          "userId": "<string>",
          "assignedInScope": {
            "type": "<string>",
            "id": 123,
            "name": "<string>"
          },
          "roleId": 123,
          "roleName": "<string>",
          "roleResources": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ],
          "roleTags": [
            "<string>"
          ],
          "auditInfo": {
            "updateDate": "2023-11-07T05:31:56Z",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "createBy": "<string>"
          }
        }
      ],
      "isActive": true,
      "identityProviderId": "<string>"
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

groupCode
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json
groupCode
string | null

User Group Id

scopeTypeId
integer<int32>

Scope Type Id

scopeId
integer<int32>

Scope Id

name
string | null

Human-readable Name of the group

description
string | null

Human-readable description of the group

users
object[] | null

Users associate with a group

auditInfo
object

Response

Success

groupCode
string | null

User Group Id

scopeTypeId
integer<int32>

Scope Type Id

scopeId
integer<int32>

Scope Id

name
string | null

Human-readable Name of the group

description
string | null

Human-readable description of the group

users
object[] | null

Users associate with a group

auditInfo
object