Skip to main content
GET
/
groups
/
{id}
Get an authorization group
curl --request GET \
  --url https://api.smokeball.com/groups/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "ed028979-5b64-4f63-82ef-2deef728d852",
  "name": "Administrators",
  "principalIds": [
    "2595a645-94a2-46be-a60d-8410851a9671",
    "2595a645-94a2-46be-a60d-8410851a9671"
  ],
  "isDeleted": false
}

Authorizations

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

Path Parameters

​
id
string
required

Response

When request is successful. Returns an authorization 'Group' object.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the group.

Example:

"ed028979-5b64-4f63-82ef-2deef728d852"

​
name
string | null

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"
]
​
isDeleted
boolean

True when the group is deleted.

Example:

false