All pages
Powered by GitBook
1 of 1

Loading...

Get user group

Gets a single 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
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/public/v1/accounts/user-groups/{id}
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"
    }
  ]
}

Get user group by ID