Get user group

Gets a single user group by ID.

Get user group by ID

get

Get user group by ID. Returns a single user group with id, name, description, account, modules, users, buyers, and default flag. Optional select query parameter controls which fields are returned.

Path parameters

idstringRequired

User group identifier.

Query parameters

selectstringOptional

Optional RQL select statement to limit returned fields.

Responses

200

OK

application/json

idstringOptional

namestringOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

logostring · nullableOptional

isDefaultbooleanOptional

404

Not Found

application/json

get

/public/v1/accounts/user-groups/{id}

HTTPcURLJavaScriptPython

GET /public/v1/accounts/user-groups/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "UGR-5116-6265",
  "revision": 2,
  "name": "Test-1",
  "description": "Group for access management",
  "isDefault": false,
  "account": {
    "id": "ACC-1234-5678",
    "name": "Microsoft"
  },
  "modules": [
    {
      "id": "MOD-1756-1452",
      "name": "Access management"
    },
    {
      "id": "MOD-9042-8216",
      "name": "Account management"
    }
  ],
  "users": [
    {
      "id": "USR-0000-0016",
      "name": "Astha Pruthi"
    }
  ]
}