Get details of user group

GET /api-v1/user-group/{id}

Headers

  • TARGET-ORGANIZATION-ID integer(int32)

    ID of organization, for which the operation must be performed

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

Path parameters

  • id integer Required

    id

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • description string
    • globalRoles array[object]
      Hide globalRoles attributes Show globalRoles attributes object
      • id integer
      • name string
      • roleType string

        Values are ORGANIZATION or GLOBAL.

    • groupIds array[integer]
    • id integer
    • isAdvanced boolean
    • name string
    • roles array[object]
      Hide roles attributes Show roles attributes object
      • id integer
      • name string
      • roleType string

        Values are ORGANIZATION or GLOBAL.

    • rule string
    • type string

      Values are GROUP or SUPER_GROUP.

    • userIds array[integer]
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/user-group/{id}
curl \
 --request GET 'https://wyzio.app/api-v1/user-group/{id}' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"
Response examples (200)
{
  "description": "string",
  "globalRoles": [
    {
      "id": 42,
      "name": "string",
      "roleType": "ORGANIZATION"
    }
  ],
  "groupIds": [
    42
  ],
  "id": 42,
  "isAdvanced": true,
  "name": "string",
  "roles": [
    {
      "id": 42,
      "name": "string",
      "roleType": "ORGANIZATION"
    }
  ],
  "rule": "string",
  "type": "GROUP",
  "userIds": [
    42
  ]
}