Resource: Permission ( /api/permission/{id} )

Permission resource.

This resource supports the following methods: GET

Methods

GET

Retrieves a permission by it's unique ID.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.

Example - Retrieve a permission (and all it's children)

Returns a single permission identified by it's unique ID

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}16342c78-d2ec-4436-a9c3-aaa105cafda4Unique ID of the permission to retrieve

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Id": "16342c78-d2ec-4436-a9c3-aaa105cafda4",
  "DisplayName": "Resources",
  "Key": "/Resources",
  "Name": "Resources",
  "Children": [
    {
      "Id": "38d05448-09f7-4a13-b091-bc271d148246",
      "DisplayName": "Resources -> External Links",
      "Key": "/Resources/ExternalLinks",
      "Name": "External Links",
      "Children": [],
      "Self": "http://localhost/api/permission/38d05448-09f7-4a13-b091-bc271d148246"
    }
  ],
  "Self": "http://localhost/api/permission/16342c78-d2ec-4436-a9c3-aaa105cafda4"
}

Status Code

200 - OK

  • No labels