v1

latestOpenAPI 3.0.02026-08-0645003.8 MB

Organizations

Create a new User Group

Create a new user-group of your Spot organization

post/setup/access/userGroup

Request body

idstring

user group id

namestring

Name of the user group. Note: names cannot include these characters: + = @

descriptionstring

user group description

createdAtstring

user group creation timestamp

userIdsstring[]

The users to register under the created group (should be existing users only)

Example request

{
  "id": "ugr-a1b2c3d4",
  "name": "Developers",
  "description": "managing permissions to my group of developers",
  "createdAt": "2020-11-04T11:29:10.000+0000",
  "userIds": [
    "u-12345678",
    "pu-12345678"
  ],
  "policies": [
    {
      "policyId": "pol-12345678",
      "accountIds": [
        "*"
      ]
    },
    {
      "policyId": "pol-87654321",
      "accountIds": [
        "act-12345678",
        "act-87654321"
      ]
    }
  ]
}