Create user group

Creates a user group for the client account.

Create user group

post

Create user group. Accepts account reference, name, optional description and logo, modules (at least one), and optional buyers and extensions. Returns the created user group object with revision 1.

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstring · nullableOptional

logostring · nullableOptional

Responses

201

Created

application/json

idstringOptional

namestringOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

logostring · nullableOptional

isDefaultbooleanOptional

400

Bad Request

application/json

post/public/v1/accounts/user-groups

HTTPcURLJavaScriptPython

POST /public/v1/accounts/user-groups HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "account": {
    "id": "ACC-1234-5678"
  },
  "name": "Rolls-Royce",
  "description": "The best car producer ever",
  "modules": [
    {
      "id": "MOD-1756-1452"
    },
    {
      "id": "MOD-9042-8216"
    }
  ],
  "buyers": null,
  "extensions": null
}

application/jsontext/jsonapplication/*+json

{
  "id": "UGR-5116-6265",
  "revision": 1,
  "name": "Rolls-Royce",
  "description": "The best car producer ever",
  "isDefault": false,
  "account": {
    "id": "ACC-1234-5678",
    "name": "Microsoft"
  },
  "modules": [
    {
      "id": "MOD-1756-1452"
    },
    {
      "id": "MOD-9042-8216"
    }
  ],
  "audit": {
    "created": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    },
    "updated": {
      "at": "2024-02-01T09:12:23+00:00",
      "by": {
        "id": "USR-0001",
        "name": "Ops User"
      }
    }
  }
}