Authorization

Create an authorization group

Creates an authorization group.

post/groups

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/groups
  • Auth
    API key in header x-api-key and API key in header Authorization

Request body

namestring nullable

s Name of the group.

principalIdsstring[] nullable

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

Example request

{
  "name": "Administrators",
  "principalIds": [
    "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.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.