Get role mappings of the group

1min
GET
https://{domain}/app/api/v2/users/groups/{groupId}/role-mapping
Get roles of 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
*
Responses
200
Get Groups Response
object
data
GroupBase[]
request
Request
error
Error
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/api/v2/users/groups/{groupId}/role-mapping' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/app/api/v2/users/groups/{groupId}/role-mapping' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
default
// Get Groups Response 
{
  "data": [
    {
      "groupId": "platform:os1devs:group:Field-Executive",
      "name": "Field-Executive",
      "description": "On ground employees who are working to pickup or drop the orders",
      "roles": [
        "Platform:Role:platform:app:example:example-editor"
      ],
      "isActive": true
    }
  ],
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  }
}
// Get Groups Response 
{
  "data": [
    {
      "groupId": "platform:os1devs:group:Field-Executive",
      "name": "Field-Executive",
      "description": "On ground employees who are working to pickup or drop the orders",
      "roles": [
        "Platform:Role:platform:app:example:example-editor"
      ],
      "isActive": true
    }
  ],
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  }
}
﻿
﻿
Updated 15 Mar 2024
Did this page help you?
Update role mappings of the group
Get Categories of the users