Skip to main content
PUT
/
groups
/
{id}
Update an authorization group
curl --request PUT \
  --url https://api.smokeball.com/groups/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "principalIds": [
    "2595a645-94a2-46be-a60d-8410851a9671",
    "2595a645-94a2-46be-a60d-8410851a9671"
  ]
}
'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
id
string
required

Body

ā€‹
principalIds
string[] | null

Principals that are members of the group. This can be either user ids or other group ids.

Example:
[
  "2595a645-94a2-46be-a60d-8410851a9671",
  "2595a645-94a2-46be-a60d-8410851a9671"
]

Response

When request is accepted. Returns a hypermedia 'Link' object of the authorization group to be updated.

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET