[Vorschau] Prüfungsprotokolle abrufen

Ruft die Prüfungsprotokolle für eine Organisation basierend auf dem Organisationsnamen ab.

API-Endpunkt

https://{yourDomain}/audit_/api/auditlogs

Scopes

Folgende Scopes sind erforderlich:

PM.Audit
PM.Audit.Read

Anforderungsheader

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Hinweis: Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren .

Abfrageparameter

Abfrageparameter	Datentyp	Beschreibung
`language` (optional)	string	Geben Sie die verfügbare Anzeigesprache in verkürzter Form an. Zum Beispiel: `en`, `fr`, `de`, `ja` etc.
`top` (optional)	Int32	Zeigen Sie die obersten N Einträge der Prüfung an.
`skip` (optional)	Int32	Überspringen Sie die Anzeige der obersten N Prüfungseinträge.
`sortBy` (optional)	string	Geben Sie die DTO-Eigenschaft an, nach der Prüfungseinträge sortiert werden. Zum Beispiel: `createdOn`, `category`, `email` etc.
`sortOrder` (optional)	string	Bestimmen Sie die Sortierreihenfolge. Zum Beispiel aufsteigend (`asc`) oder absteigend (`desc`).
`api-version` (optional)	string	Geben Sie die von Ihnen verwendete API-Version an.

Antworten

200 OK

Gibt die abgefragten Prüfungsereignisse zurück.

Beispielanforderung

Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.

Ihre {baseURL} ist: https://{yourDomain}/{organizationName}/{tenantName}/
Ihre {access_token} ist: 1234 (aus Gründen der Länge).
Sie legen die folgenden Abfrageparameter fest:
- language = en
- top = 2, um die beiden obersten Einträge anzuzeigen
- skip = 2, um die ersten beiden Einträge zu überspringen
- sortBy = createdOn, um die Einträge nach ihrem Erstellungsdatum zu sortieren
- sortOrder = asc, um die Einträge vom ältesten bis zum neuesten Eintrag zu sortieren

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request GET '
				https://{yourDomain}/{organizationName}/{tenantName}/audit_/api/auditlogs/?language=en&top=2&skip=2&sortBy=createdOn&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'curl --location --request GET '
				https://{yourDomain}/{organizationName}/{tenantName}/audit_/api/auditlogs/?language=en&top=2&skip=2&sortBy=createdOn&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Hier ist der Antworttext für einen erfolgreichen Abruf von Prüfungseinträgen:

{
    "totalCount": 29,
    "results": [
        {
            "createdOn": "2021-10-14T13:10:15.1964174+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        },
....
        {
            "createdOn": "2021-10-14T12:41:00.3268964+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        }
    ]
}{
    "totalCount": 29,
    "results": [
        {
            "createdOn": "2021-10-14T13:10:15.1964174+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        },
....
        {
            "createdOn": "2021-10-14T12:41:00.3268964+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        }
    ]
}