Update an authorization group

Updates a specified authorization group.

PUT /groups/{id}

Update an authorization group

cURL

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"
  ]
}
'

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

id · string · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

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

202

application/json

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