Seitenhistorie

Authentication and Authorization

Siehe Artikel Informationen zur Authentifizierung.

Request logs

Anfrage-Protokolle

AnfrageRequest:

• EndpointEndpunkt: cloud-service-logging/accounts/$account/logs/paginated
• MethodMethode: GET
• URL Params-Parameter: lang EN/DE
  • limit Grenze: 1..200
  • categories Kategorien OTHER, DEVICE
  • marker stringMarkierungszeichenfolge

ResponseAntwort:

{
    "logs": [{
        "id": uuid,
        "messageId": string, // format 5 digit
        "created": timestamp, // yyyy-mm-ddThh:mm:ss.SSSZ
        "properties":{
            "auditEntityId": uuid,
            "auditNewValue": string,
            "auditOldValue": string,
            "auditSourceIp": string, // IPv4 address
            "auditEntityName": string,
            "auditEntityType": string,
            "auditSourceAgent": string,
            "auditOldValueChange": string,
            "auditNewValueChange": string
        },
        "references":[
            {
                "id": uuid,
                "type": string // account, addin, device, network, principal, site, page
            },
            {
                "id": uuid,
                "type": string,
                "name": string
            }],
        "data":[],
        "accountId": uuid,
        "originatorId": uuid,
        "serviceId": uuid,
        "serviceName": string,
        "logLevel": string, // INFO, WARNING, ERROR
        "message": string
        "isAuditLog": boolean
        },
        ...
    ],
    "next": string, // this parameter is optional
    "previous": string // this parameter is optional
}

Markers

The log messages API returns up to two markers: next and previous. These markers have the following format:

{
        "type": string // NEXT_PAGE, PREVIOUS_PAGE
        "logCreatedAt": timestamp // seconds from 1/1/1970
        "logPersistedAt": timestamp // seconds from 1/1/1970
    }

Die Markierung ist die url-kodierte Version des nächsten Feldes.

Es ist möglich, Protokolle anzufordern, die neuer sind als ein bestimmter Zeitstempel:

curl -X GET -H  "accept: application/json" -H  "Authorization: Bearer $token" https://cloud

The marker is the url-encoded version of next field.

It is possible to request the logs newer than a specific timestamp:

curl -X GET -H  "accept: application/json" -H  "Authorization: Bearer $token" https://cloud.lancom.de/cloud-service-logging/accounts/$account/logs/paginated?lang=EN&categories=OTHER&marker=%7B%22type%22:%22PREVIOUS_PAGE%22,%22logCreatedAt%22:1613145056300000%7D

Reference Resolution

Referenzauflösung

Das Log-Objekt enthält verschiedene Arten von Referenzen, das Referenzformat istThe log object contains different types of references, the reference format is:

{
    "id": uuid
    "type": string
    "name": string
}

The id and type are mandatory and always present in the reference object. The name is optional, and present only for the reference of type principal.

Account

This reference represents the project, the organization or the distribution.

Request:

und type sind obligatorisch und immer im Referenzobjekt vorhanden. Der Name ist optional und nur für die Referenz vom Typ principal vorhanden.

Account

Diese Referenz steht für das Projekt, die Organisation oder die Verteilung.

Anfrage:

• EndpunktEndpoint: /cloud-service-auth/accounts
• MethodMethode: GET
• URL params-Parameter:
  • id: list of account uuidsListe von Konto-UUIDs

AntwortResponse:

[
  {
    "name": string,
    "id": uuid,
    "parent": uuid,
    ...
    "identifier": string,
    "created": timestamp, // yyyy-mm-ddThh:mm:ss.SSS+ZZ:ZZ
    ...
  }
]

Addin

RequestAnfrage:

Endpunkt: /cloud-service-config/configapplication/accounts/$account/applications

Methode: GET

ResponseAntwort:

[
  {
    "name": string,
    "enabled": boolean,
    "type": string,
    ...
    "id": uuid
  },
  ...
]

Device

RequestAnfrage:

• EndpointEndpunkt: cloud-service-devices/accounts/$account/devices
• MethodMethode: GET
• URL params-Parameter:
  • id: device uuid

ResponseAntwort:

[
  {
    "id": uuid,
    "status": {
      "name": string,
      "serial": string,
      ...
    },
    ...
  }
]

Network

RequestAnfrage:

• EndpointEndpunkt: /confignetwork/accounts/$account/networks
• MethodMethode: GET

ResponseAntwort:

[
  {
    "id": uuid,
    "name": string,
    ...
]

Principal

RequestAnfrage:

• EndpointEndpunkt: /cloud-service-auth/accounts/$account/members
• MethodMethode: GET
• URL params-Parameter:
  • id: principal uuid

ResponseAntwort:

[
  {
    "id": uuid,
    "icon": string,
    "name": string,
    "email": string,
    ...
  }
]

Site

RequestAnfrage:

• EndpointEndpunkt: /cloud-service-devices/accounts/$account/sites
• MethodMethode: GET
• URL params-Parameter:
  • id: site uuid

ResponseAntwort:

[
  {
    "name": string,
    "comment": string,
    ...
    "id": uuid,
    ...
  }
]

Page

The page reference has a static resolutionDer Seitenverweis hat eine statische Auflösung:

Template and Reference

The log messages are immutable, it is not possible to change in the database. The rendering of the messages changes, we use a template to then be able to have the updated naming of devices, networks, principals...

Vorlage und Referenz

Die Protokollmeldungen sind unveränderlich, eine Änderung in der Datenbank ist nicht möglich. Wenn sich die Darstellung der Meldungen ändert, verwenden wir eine Vorlage, um die aktualisierte Benennung von Geräten, Netzwerken, Auftraggebern usw. übernehmen zu können.

Hier einige Beispiele für VorlagenHere some template examples:

"User {ref:f16783c3-cb0c-3727-95c1-0752f938f7a7} has logged in for this account"
"The device {ref:ce4e47f6-c374-44dd-ba58-750a06e9c363} has established its cloud connectivity."

The string Die Zeichenfolge {ref:uuid} is replaced with name of the reference. Some references have the name embedded in the log messages (e.gwird durch den Namen der Referenz ersetzt. Bei einigen Referenzen ist der Name in die Protokollnachrichten eingebettet (z. B. metric, principal), other references only specify the type and the uuid. The name resolution then requires an additional call to the corresponding API, listed above.bei anderen Referenzen werden nur der Typ und die uuid angegeben. Die Namensauflösung erfordert dann einen zusätzlichen Aufruf der entsprechenden, oben aufgeführten API.