Get Organisation Service

This endpoint retrieves detailed information about a specific service associated with an organisation. It provides key details such as the service name, type, status, and functionality. The response includes relevant attributes, such as dependencies, supported features, and configuration settings. Additionally, it provides infrastructure details and active endpoints related to the service, ensuring comprehensive visibility and effective management.

Syntax: see 'CCall Structure

Type = 'GET'

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

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:

{ "created": { "time": time, "user": { "id": "user-id", "detail": { "givenName": "given-name", "surname": "surname", "displayName": "display-name", "email": "account-email" } } }, "updated": { "time": time }, "id": "service-id, "activated": activated, "roles": [ { "id": "role-id", "name": "role-name", "type": "role-type", "description": "role-description", "permissions": { "allowed": ["permission"], "denied": ["permission"] } } ], "type": "service-type", "address": { "hostName": "service-hostname", "port": service-port }, "computer": { "id": "computer-id", "name": "computer-name" }, "organization": { "id": "organisation-id", "name": "organisaion-name }, "secret": "service-secret" }

Output	Description
time	The hub time, shown as an integer in ms
computer-id	This is the id of the computer as a unique 128-bit number
user-id	This is the id of the user as a unique 128-bit number
given-name	The first name of the user
surname	The surname of the user
display-name	The account name of the user
account-email	The email of the user
service-id	This is the id of the service as a unique 128-bit number
activated	Is the service activated or not
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
service-type	This is the type of service e.g. cloud or host
service-hostname	This is the hostname of the service
service-port	This is the port the service is using
computer-id	This is the id of the computer as a unique 128-bit number
computer-name	The name of the computer
organisation-id	This is the id of the organisation as a unique 128-bit number
organisation-name	This is the name of the organisation
service-secret	The secret of the service

Example

curl -X 'GET' \
  'https://connect.cambrionix.com/api/v1/organizations/40f5a1a7-3119-4961-8493-866c4053b7eb/services/bd2fd2d4-3f39-4e0b-a1f7-e4e8cc331ff9' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzIPc5X3A'
                                            

Returns

This response has been truncated for clarity within the manual.

{
  "result": {
    "created": {
      "time": 1712828249564,
      "user": {
        "id": "46bbf7f5-1794-411d-b42b-97ab2fe12460",
        "detail": {
          "givenName": "Nick",
          "surname": "Metcalfe",
          "displayName": "unknown",
          "email": "nicholas.metcalfe@cambrionix.com"
        }
      }
    },
    "updated": {
      "time": 1739954951602
    },
    "id": "bd2fd2d4-3f39-4e0b-a1f7-e4e8cc331ff9",
    "activated": true,
    "roles": [
      {
        "id": "00000000-0000-0000-0000-000000000005",
        "name": "Hardware API Service Role",
        "type": "built-in",
        "description": "Contains permissions required by the Hardware API Service.",
        "permissions": {
          "allowed": [
            "Organization.Read",
      ...
          ],
          "denied": []
        }
      }
    ],
    "type": "host",
    "address": {
      "hostName": "cbrxci-011.api.cambrionix.com",
      "port": 43424
    },
    "computer": {
      "id": "b9238504-276e-49c1-8caa-e4f14bce4ba6",
      "name": "CBRXCI-011"
    },
    "organization": {
      "id": "40f5a1a7-3119-4961-8493-866c4053b7eb",
      "name": "Connect Premium"
    },
    "secret": "06S+EOLfi895BKU="
  }
}
                                            

Errors

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