SMsmokeball
Authorization

Get an authorization group

Retrieves a specified authorization group.

get/groups/{id}

Request

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

Path parameters

idstring required

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the group.

namestring nullable

Name of the group.

principalIdsstring[] nullable

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

isDeletedboolean

True when the group is deleted.

Example response

{
  "id": "ed028979-5b64-4f63-82ef-2deef728d852",
  "name": "Administrators",
  "principalIds": [
    "2595a645-94a2-46be-a60d-8410851a9671",
    "2595a645-94a2-46be-a60d-8410851a9671"
  ]
}

Changes

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