update a Group by groupId.

1min
PUT
https://{domain}/app/api/v2/users/groups/{groupId}
Edit a Group. Group provides a logical wrapping for users within tenant. Users within group share the roles of the group. 
Path Parameters
groupId
string
*
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-REQUEST-ID
string
*
Body Parameters
body
UpdateGroupRequest
Description
Update Group Request
addRoles
string[]
removeRoles
string[]
Responses
200
Request completed
GroupEditResponse
data
object
error
Error
request
Request
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/users/groups/{groupId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/users/groups/{groupId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
Responses
200
default
// Request completed 
{
  "data": {
    "id": "platform:os1devs:group:Field-Executive",
    "add": {
      "id": "platform:os1devs:group:Field-Executive",
      "status": ""
    },
    "remove": {
      "id": "platform:os1devs:group:Field-Executive",
      "status": ""
    }
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
// Request completed 
{
  "data": {
    "id": "platform:os1devs:group:Field-Executive",
    "add": {
      "id": "platform:os1devs:group:Field-Executive",
      "status": ""
    },
    "remove": {
      "id": "platform:os1devs:group:Field-Executive",
      "status": ""
    }
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
﻿
﻿
Updated 15 Mar 2024
Did this page help you?
Get all groups of a tenant.
Update role mappings of the group