Get Roles for an Organisation Service

This endpoint retrieves all roles available for an organisation service, providing essential details such as role names, descriptions, and associated permissions. It enables effective role-based management by outlining access levels, responsibilities, and supported actions for each role. The response includes key attributes such as dependencies, supported features, configuration settings, and infrastructure details. By accessing role information, organisations can ensure proper governance, secure access control, and efficient service management.

Syntax: see 'CCall Structure

Type = 'GET'

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

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:

[ { "id": "role-id", "name": "role-name", "type": "role-type", "description": "role-description", "permissions": { "allowed": ["permission"], "denied": ["permission"] } } ]

Output	Description
role-id	This is the id of the role as a unique 128-bit number
role-name	The name of the role
role-type	The type of role such as organisation or Built-in role
role-description	The description of the role
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/roles' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIJQinw'
                                            

Returns

This response has been truncated for clarity within the manual.

{
  "result": [
    {
      "id": "636c21cb-29d7-47d2-9f40-94f441711b0b",
      "name": "My First Custom Role",
      "type": "organization",
      "description": "My First Custom Role",
      "permissions": {
        "allowed": [
          "Organization.Service.Read",
          "Organization.Service.Write",
          "Organization.Service.Delete",
          "Organization.Service.Secret.Read"
        ],
        "denied": []
      }
    }
  }
}
                                            

Errors

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