All pages
Powered by GitBook
1 of 11

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Create account user

Get account user

Get a single account user by ID.

Account User

This object contains the following attributes:

Field
Type
Description

id

string, core

(Read-only) The primary identifier for the account user.

user

object, core

Represents the object.

account

object, core

Represents the object.

invitation

string

(Read-only) The status of the invitation. Allowed values are:

  • Invited

  • Active

  • InvitationExpired

groups

object

Represents the object containing a list of groups.

ACCOUNT USER OBJECT
{
    "$meta": {
        "pagination": {
            "offset": 0,
            "limit": 10,
            "total": 1
        },
        "omitted": [
            "audit"
        ]
    },
    "data": [
        {
            "id": "AUSR-4134-7183-7330",
            "user": {
                "id": "USR-6375-2499",
                "email": "janedoe@example.com",
                "firstName": "jane",
                "lastName": "doe"
            },
            "groups": [
                {
                    "id": "UGR-8447-7590",
                    "name": "Reto",
                    "description": "Mayer",
                    "logo": "",
                    "isDefault": false
                }
            ],
            "account": {
                "id": "ACC-1671-0642",
                "icon": null,
                "name": "This is my account."
            },
            "invitation": {
                "code": "TEST",
                "status": "Invited"
            }
        }
    ]
}

Example

user
account
group

Delete account user

Deletes a user from the account. The user remains active in other accounts.

List account users

Get all users assigned to an account.

Update user group assignment

Resend user invitation

Resends the invitation to the user.

Remove user

Removes a user from a specific group.

Assign user to groups

Assign an account user to a specific group.

Send new invitation

Sends a new invitation if the original invite has expired.

Accept user invitation

Accepts the user invitation to the account.

Deprecated
put
Path parameters
idstringRequired
Body
idall ofOptional
anyOptionalPattern: ^UGR-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^UGR-\d\d\d\d-\d\d\d\d$
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
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
put/public/v1/accounts/account-users/{id}/groups
PUT /public/v1/accounts/account-users/{id}/groups HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}
Deprecated
post
Path parameters
idstringRequired
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
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/accounts/account-users/{id}/resend-invite
POST /public/v1/accounts/account-users/{id}/resend-invite HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}
Deprecated
delete
Path parameters
idstringRequired
userGroupIdstringRequired
Responses
204

No Content

No content

400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
delete/public/v1/accounts/account-users/{id}/groups/{userGroupId}
DELETE /public/v1/accounts/account-users/{id}/groups/{userGroupId} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

No content

Deprecated
post
Path parameters
idstringRequired
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
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/accounts/account-users/{id}/send-new-invite
POST /public/v1/accounts/account-users/{id}/send-new-invite HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}
Deprecated
post
Body
idstring · nullableOptional
emailstring · emailOptional
firstNamestring · nullableOptional
lastNamestring · nullableOptional
prefixstring · max: 10 · nullableOptional
numberstring · max: 15 · nullableOptional
cultureCodestring · nullableOptional
dateFormatstring · nullableOptional
languageCodestring · nullableOptional
decimalSeparatorstringOptional
groupSeparatorstringOptional
timeFormatstring · nullableOptional
timeZonestring · nullableOptional
notesstring · nullableOptional
idstring · nullableOptional
emailstring · emailOptional
firstNamestring · nullableOptional
lastNamestring · nullableOptional
prefixstring · max: 10 · nullableOptional
numberstring · max: 15 · nullableOptional
cultureCodestring · nullableOptional
dateFormatstring · nullableOptional
languageCodestring · nullableOptional
decimalSeparatorstringOptional
groupSeparatorstringOptional
timeFormatstring · nullableOptional
timeZonestring · nullableOptional
notesstring · max: 2000 · nullableOptional
idall ofOptional
anyOptionalPattern: ^ACC-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^ACC-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^ACC-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^ACC-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^ACC-\d\d\d\d-\d\d\d\d$
idall ofOptional
anyOptionalPattern: ^UGR-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^UGR-\d\d\d\d-\d\d\d\d$
statusstringOptional
Responses
201

Created

application/json
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/accounts/account-users
POST /public/v1/accounts/account-users HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 393

{
  "id": "text",
  "email": "name@gmail.com",
  "firstName": "text",
  "lastName": "text",
  "phone": {
    "prefix": "text",
    "number": "text"
  },
  "settings": {
    "cultureCode": "text",
    "dateFormat": "text",
    "languageCode": "text",
    "numberFormat": {
      "decimalSeparator": "text",
      "groupSeparator": "text"
    },
    "timeFormat": "text",
    "timeZone": "text"
  },
  "notes": "text",
  "account": {
    "id": "text"
  },
  "groups": [
    {
      "id": "text"
    }
  ],
  "invitation": {
    "status": "text"
  }
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}
Deprecated
get
Path parameters
idstringRequired
Query parameters
selectstringOptional
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
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/public/v1/accounts/account-users/{id}
GET /public/v1/accounts/account-users/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}

Delete user from account

delete

Delete user from account. Available for account users with platform account management permissions or to the user himself. When user removes himself from the account, that means leaving the account. Returns 204 No Content on success.

Path parameters
accountIdstringRequired

Account identifier.

userIdstringRequired

User identifier.

Responses
204

No Content

No content

400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
delete/public/v1/accounts/accounts/{accountId}/users/{userId}
DELETE /public/v1/accounts/accounts/{accountId}/users/{userId} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

No content

Deprecated
get
Responses
200

OK

application/json
offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
get/public/v1/accounts/account-users
GET /public/v1/accounts/account-users HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
        "access": {
          "at": "2026-01-01T00:00:00.000Z"
        },
        "joined": {
          "at": "2026-01-01T00:00:00.000Z"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "user": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      },
      "groups": [
        {
          "id": "text",
          "name": "text",
          "revision": 1,
          "description": "text",
          "logo": "text",
          "isDefault": true
        }
      ],
      "buyers": [
        {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      ],
      "modules": [
        {
          "id": "text",
          "name": "text",
          "revision": 1,
          "description": "text",
          "filters": {
            "group.buyers": [
              "text"
            ]
          },
          "settings": {
            "configurable": true,
            "default": true,
            "paid": true,
            "type": [
              "text"
            ],
            "obsolete": true,
            "eligibility": {
              "multi": true,
              "single": true
            }
          }
        }
      ],
      "account": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      },
      "invitation": {
        "url": "text",
        "notes": "text",
        "status": "text"
      },
      "lastLoginAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}
Deprecated
post
Path parameters
idstringRequired
Body
idall ofOptional
anyOptionalPattern: ^UGR-\d\d\d\d-\d\d\d\d$
and
anyOptionalPattern: ^UGR-\d\d\d\d-\d\d\d\d$
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
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/accounts/account-users/{id}/groups
POST /public/v1/accounts/account-users/{id}/groups HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}
Deprecated
post
Path parameters
idstringRequired
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
invitationAcceptedAtstring · date-time · nullableOptional
atstring · date-time · nullableOptional
atstring · date-time · nullableOptional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
lastLoginAtstring · date-time · nullableOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/accounts/account-users/{id}/accept-invite
POST /public/v1/accounts/account-users/{id}/accept-invite HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "invitationAcceptedAt": "2026-01-01T00:00:00.000Z",
    "access": {
      "at": "2026-01-01T00:00:00.000Z"
    },
    "joined": {
      "at": "2026-01-01T00:00:00.000Z"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "user": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "groups": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "logo": "text",
      "isDefault": true
    }
  ],
  "buyers": [
    {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1
    }
  ],
  "modules": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "invitation": {
    "url": "text",
    "notes": "text",
    "status": "text"
  },
  "lastLoginAt": "2026-01-01T00:00:00.000Z"
}