Get Permissions for an Organisation Service

This endpoint retrieves all built-in permissions available for an organisation service, detailing the actions that can be assigned, such as reading, writing, and deleting resources. It provides key information, including permission names, descriptions, and associated functionalities, enabling effective role-based access control and streamlined service management.

Syntax: see 'CCall Structure

Type = 'GET'

'https://connect.cambrionix.com/api/v1/organizations/organisation-id/services/service-id/role/permissions'

Variable	Description
organisation-id	This is the unique id of the organisation as a unique 128-bit number
service-id	This is the id of the service as a unique 128-bit number

Returns:

{ ["permission"], }

Output	Description
permission	The associated permission names and descriptions

Example

curl -X 'GET' \
  'https://connect.cambrionix.com/api/v1/organizations/40f5a1a7-3119-4961-8493-866c4053b7eb/services/00000000-0000-0000-0000-000000000005/role/permissions' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImOTJQinw'
                                            

Returns

This response has been truncated for clarity within the manual.

{
  "result": [
    {
      "name": "Organization.Read",
      "description": "Grants the ability to read information."
    },
    {
      "name": "Organization.Write",
      "description": "Grants the ability to write organization services."
    },
    {
      "name": "Organization.License.Read",
      "description": "Grants the ability to read organization licenses."
    },
    {
      "name": "Organization.UserGroups.Write",
      "description": "Grants the ability to write User Group assignments."
    },
    {
      "name": "Organization.UserGroups.Read",
      "description": "Grants the ability to read User Group assignments."
    },
    {
      "name": "Organization.UserGroups.Delete",
      "description": "Grants the ability to delete User Group assignments."
    },
    {
      "name": "Organization.UserGroups.Users.Write",
      "description": "Grants the ability to write User Group assignments."

    {
      "name": "Global.License.Write",
      "description": "Grants the ability to write licenses."
    },
    {
      "name": "Organization.Locations.Delete",
      "description": "Grants the ability to delete organization locations."
    }
  ]
}
                                            

Errors

If there is an error in the API method then JSON-RPC Error Object a will be returned