Skip to main content
PUT
/
v1
/
permission-groups
/
{id}
/
users
Add Users to Permission Group
curl --request PUT \
  --url https://sandbox-api.borderless.xyz/v1/permission-groups/{id}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "dashboardPermissions": [
    "OrganizationApiKeysGenerate"
  ],
  "dashboardUsers": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "businessTitle": "<string>",
      "role": "OWNER",
      "deleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "mfaEnabled": true,
      "dashboardPermissions": [
        "OrganizationApiKeysGenerate"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
users
string[]
required

List of dashboard user ids

Minimum length: 1

Response

200 - application/json

Users were successfully added to the Permission Group.

id
string
required
name
string
required
dashboardPermissions
enum<string>[]
required
description
string | null
dashboardUsers
object[]