Vertec Python Modul "vtcauth"

Ab Version 6.8 gibt es das Vertec Python Modul vtcauth, um eine OAuth Authentisierung in beliebigen Schnittstellen und Python Scripts in Vertec verwenden zu können.

Dieses beinhaltet einen Decorator authenticate, welchem als Argument ein config Dictionary mitgegeben wird. 

Die Parameter, welche im config Dictionary mitgegeben werden können, sind folgende in vtcauth vorhandenen Instanzvariablen:

"https://graph.microsoft.com/.default offline_access"

"https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/authorize"

"https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/token"

Der minimale Aufruf (für MS Graph) in einem Script sieht so aus:

from vtcauth import authenticate
# config example using vertec properties with prefix
config_prefix = {
    "tenant_id":"xxxxxxxxxxxxxxxxxxx.onmicrosoft.com",
    "prefix":"DmsSharePoint",
    "logging":True,}
# using decorator from vtcauth with config_prefix dict
@authenticate(config_prefix)

Die gesamte OAuth Authentisierung findet über den Decorator @authenticate(config_prefix) statt.

Falls der User in der angesprochenen Applikation nicht bereits angemeldet ist, hat er für die Authentisierung eine Minute Zeit. Meldet er sich im geöffneten Login Dialog des angesprochenen Produkts nicht innerhalb von einer Minute an, gibt es ein Timeout.

Falls das Token abgelaufen oder ungültig ist, kann eine TokenExpiredException aufgerufen werden. Diese triggert den OAuth Mechanismus, um neue Tokens zu holen. Ist ein RefreshToken vorhanden und gültig, wird das AccessToken mit dem RefreshToken geholt. Die Exception kann im gleichen Aufruf (standardmässig) maximal dreimal ausgeführt werden, danach wird ein Fehler geworfen.

Beispiel

In diesem Beispiel werden die ersten 10 Sites eines SharePoint ausgegeben (MS Graph mit OAuth Authentisierung):

import requests
from vtcauth import authenticate, TokenExpiredException

# config example using vertec properties with prefix
config_prefix = {
    "tenant_id":"xxxxxxxxxxxxxxxxxxx.onmicrosoft.com",
    "prefix":"DmsSharePoint",
    "logging":True,}

class SharePointSiteQuery:
    # using decorator from vtcauth with config_prefix dict
    @authenticate(config_prefix)
    def get_sites_with_prefix_config(self):
        return self.get_sites()

    def get_sites(self):
        headers = {
            "Authorization": "Bearer {}".format(self.access_token),
            "Content-Type": "application/json",}
        response = requests.get("https://graph.microsoft.com/v1.0/sites?search=*&$top=10", headers=headers)
        if response.ok:
            content = response.json()
        elif: response.status_code == requests.codes.unauthorized:
            raise TokenExpiredException
        else:
            print(response.json().get("error").get("code") + ' - ' + response.json().get("error").get("message"))

query = SharePointSiteQuery()
query.get_sites_with_prefix_config()

Die Vertec SharePoint Extension verwendet neu intern ebenfalls das Modul vtcauth. Am Betrieb der Schnittstelle ändert sich dadurch nichts.

Stub File

Das Modul vtcauth wird auch als Stub File mitgeliefert.

Verwendung in geplanten Aufgaben

Ab Vertec 6.8.0.12 kann das Modul vtcauth auch via geplante Aufgaben verwendet werden.

Wenn individuelle Anmeldung verwendet wird, muss wie folgt vorgegangen werden:

• Als Administrator an Vertec und beim Drittsystem anmelden
• Auf der geplanten Aufgabe muss dieser User hinterlegt werden
• Die geplante Aufgabe einmal manuell ausführen, so werden AccessToken und RefreshToken auf dem Administrator gespeichert und die geplante Aufgabe kann später selbständig darauf zugreifen. 
• Das AccessToken wird so lange automatisch erneuert, wie das RefreshToken gültig ist. Läuft auch das RefreshToken ab, muss die geplante Aufgabe erneut einmal manuell ausgeführt werden. 
• Wann das RefreshToken abläuft, wird in einer Benutzerproperty expires_at hinterlegt und kann vom Administrator, wenn er in Vertec eingeloggt ist, via vtcapp.getpropertyvalue() abgefragt werden.