User Group Properties - Adds User to User Group (Deprecated)

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This operation updates the properties associated with a user group.

More Details

Path Parameters

• UserGroupId string required

application/json

Request Body required

• groups object[]

  description string

  enabled boolean

  usersOperationType integer

  userGroupEntity object

  userGroupName string

  users object[]

  userName string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• User Group Properties - This request deletes a security association.

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  errorString string

  errorCode integer

  entity object

  userGroupName string

  userGroupId integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorString": "string",
      "errorCode": 0,
      "entity": {
        "userGroupName": "string",
        "userGroupId": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorString": "Successful",
      "errorCode": 0,
      "entity": {
        "userGroupName": "Testgroup",
        "userGroupId": 9
      }
    }
  ]
}

POST /usergroup/:usergroupid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

UserGroupId — path required

Body required

• Default
• User Group Properties - Adds User to User Group

---

{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/UserGroup/:UserGroupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "groups": [
    {
      "description": "string",
      "enabled": true,
      "usersOperationType": 0,
      "userGroupEntity": {
        "userGroupName": "string"
      },
      "users": [
        {
          "userName": "string"
        }
      ]
    }
  ]
}'