1 of 6

User Groups

Group Object

The group object represents a user group in the Marketplace platform. This object contains the following properties:

Field

Type

Description

Example

{
	"id": "UGR-5116-6265",
	"href": "/user-groups/UGR-5116-6265",
	"name": "Test-1",
	"description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.",
	"modules": [
		{
			"id": "MOD-1756-1452",
			"name": "Access management"
		},
		{
			"id": "MOD-9042-8216",
			"name": "Account management"
		}
	],
	"icon": "https://picsum.photos/210/201",
	"default": true,
	"stats": {
		"users": 123
	}
}

List User Groups

Get the user groups collection.

Get User Group

Get a single user group by ID.

Create User Group

Create a user group for the client account.

Update User Group

Update a user group.

Delete User Group

Delete a user group.

List User Groups

Get the user groups collection.

GEThttps://api.platform.softwareone.com/public/v1/accounts/user-groups

Response

Success

Body

$metaobject

dataarray of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "description": "text",
      "modules": [
        {
          "id": "text",
          "href": "text",
          "description": "text",
          "isConfigurable": false,
          "isEnabledByDefault": false,
          "paid": false,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "logo": "text",
      "isDefault": false,
      "users": [
        {
          "id": "text",
          "href": "text",
          "email": "text",
          "status": "text",
          "firstName": "text",
          "lastName": "text",
          "icon": "text",
          "lastLoginAt": "2024-11-15T10:17:31.671Z",
          "name": "text",
          "accounts": [
            {
              "id": "text",
              "href": "text",
              "externalId": "text",
              "externalName": "text",
              "icon": "text",
              "technicalSupportEmail": "name@gmail.com",
              "website": "text",
              "description": "text",
              "name": "text",
              "groups": [],
              "buyers": [
                {
                  "id": "text",
                  "href": "text",
                  "icon": "text",
                  "taxId": "text",
                  "name": "text",
                  "sellers": [
                    {
                      "id": "text",
                      "href": "text",
                      "externalId": "text",
                      "icon": "text",
                      "currencies": [
                        "text"
                      ],
                      "name": "text"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Create User Group

Create a user group for the client account.

POSThttps://api.platform.softwareone.com/public/v1/accounts/user-groups

Body

namestring

descriptionnullable string

logonullable string

accountobject

modulesarray

Response

Created

Body

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2024-11-15T10:17:31.671Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "name@gmail.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Update User Group

Update a user group.

PUThttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Body

namestring

descriptionnullable string

logonullable string

modulesarray

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2024-11-15T10:17:31.671Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "name@gmail.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Delete User Group

Delete a user group.

DELETEhttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Response

No Content

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Get User Group

Get a single user group by ID.

GEThttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Query parameters

selectstring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2024-11-15T10:17:31.671Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "name@gmail.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

User Groups

Group Object

The group object represents a user group in the Marketplace platform. This object contains the following properties:

Field

Type

Description

Example

{
	"id": "UGR-5116-6265",
	"href": "/user-groups/UGR-5116-6265",
	"name": "Test-1",
	"description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.",
	"modules": [
		{
			"id": "MOD-1756-1452",
			"name": "Access management"
		},
		{
			"id": "MOD-9042-8216",
			"name": "Account management"
		}
	],
	"icon": "https://picsum.photos/210/201",
	"default": true,
	"stats": {
		"users": 123
	}
}

Statistics of the group. A

group can be deleted only if the UsersCount is 0.

Example:

{
  "users": 123
}

DELETEhttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Response

No Content

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

GEThttps://api.platform.softwareone.com/public/v1/accounts/user-groups

Response

Success

Body

$metaobject

dataarray of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "description": "text",
      "modules": [
        {
          "id": "text",
          "href": "text",
          "description": "text",
          "isConfigurable": false,
          "isEnabledByDefault": false,
          "paid": false,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "logo": "text",
      "isDefault": false,
      "users": [
        {
          "id": "text",
          "href": "text",
          "email": "text",
          "status": "text",
          "firstName": "text",
          "lastName": "text",
          "icon": "text",
          "lastLoginAt": "2024-11-15T10:17:31.671Z",
          "name": "text",
          "accounts": [
            {
              "id": "text",
              "href": "text",
              "externalId": "text",
              "externalName": "text",
              "icon": "text",
              "technicalSupportEmail": "name@gmail.com",
              "website": "text",
              "description": "text",
              "name": "text",
              "groups": [],
              "buyers": [
                {
                  "id": "text",
                  "href": "text",
                  "icon": "text",
                  "taxId": "text",
                  "name": "text",
                  "sellers": [
                    {
                      "id": "text",
                      "href": "text",
                      "externalId": "text",
                      "icon": "text",
                      "currencies": [
                        "text"
                      ],
                      "name": "text"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

POSThttps://api.platform.softwareone.com/public/v1/accounts/user-groups

Body

namestring

descriptionnullable string

logonullable string

accountobject

modulesarray

Response

Created

Body

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2024-11-15T10:17:31.671Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "name@gmail.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

PUThttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Body

namestring

descriptionnullable string

logonullable string

modulesarray

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2024-11-15T10:17:31.671Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "name@gmail.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

GEThttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Query parameters

selectstring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2024-11-15T10:17:31.671Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "name@gmail.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}