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

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Body

​
name
string | null

s Name of the group.

Example:

"Administrators"

​
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 created.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
⌘I