List permissions

GET 
/organizations/:organizationId/permissions

List Permissions

Request

Path Parameters

organizationId stringrequired

Query Parameters

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array of permission objects, each representing a specific set of permissions granted or available.
Array [
id stringrequired
description stringrequired
groups string[]required
categoryId stringrequired
actionId stringrequired
createdAt numberrequired
updatedAt numberrequired
createdBy stringrequired
updatedBy stringrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "description": "string",
      "groups": [
        "string"
      ],
      "categoryId": "string",
      "actionId": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "createdBy": "string",
      "updatedBy": "string"
    }
  ]
}

Example

{
  "data": [
    {
      "id": "prm-lns:tenants:device-profiles:delete",
      "description": "Permission to delete lns:tenants:device-profiles",
      "groups": [
        "Team can Manage Assets, Asset type, Integrations, Smart workflows and Infodeck LNS"
      ],
      "categoryId": "lns",
      "actionId": "lns:tenants:device-profiles:delete",
      "createdAt": 1714365479329,
      "updatedAt": 1714365479329,
      "createdBy": "system",
      "updatedBy": "system"
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...