Skip to Content
CLIEngine-Befehlepc engine login

pc engine login

Beginnt oder erneuert eine Session mit der angegebenen Engine.

Alle anschließenden Kommandoaufrufe zum Auflisten von und Interagieren mit Prozessen verwenden die aus dem Login resultierende Identität.

Verwendung

pc engine login <engineUrl> [options]

Argumente

NameObligatorischBeschreibung
engineUrlJaURL der zu verbindenden Engine

Optionen

Name, KürzelDefaultBeschreibung
--client-idpc_cliNutzt die gegebene Client ID für den Device Flow (RFC 8628)
--scopeopenid,profile,engine_read,engine_write,engine_adminFragt die gegebenen Scopes für den Device Flow an (kommagetrennt)
--m2m-client-idNutzt die gegebene Client ID für die Machine-to-Machine-Autorisierung (M2M)
--m2m-client-secretNutzt das gegebene Client Secret für die Machine-to-Machine-Autorisierung (M2M)
--m2m-scopeFragt die gegebenen Scopes für die Machine-to-Machine-Autorisierung (M2M) an
--output, -otextSteuert das Ausgabeformat: text oder json
--rootNutzt eine anonyme Root Access Sitzung
--root-access-tokenNutzt den gegebenen String als Root Access Token

Beispiele

Login per Browser

Für den Login in eine Engine muss die URL dieser Engine angegeben werden:

pc engine login http://localhost:56000

Das Protokoll (HTTP/HTTPS) kann dabei weggelassen werden:

pc engine login localhost:56000

Ist zudem kein Host angegeben, wird localhost verbunden:

pc engine login :56000

Dieser Login nutzt den Device Flow (RFC 8628). Die CLI zeigt eine verification_uri und einen user_code im Terminal an und öffnet zusätzlich automatisch den Default-Browser, in dem der Benutzer sich anmeldet und die Berechtigungen bestätigt.

Login per Device Flow mit eigenem Client

Standardmäßig nutzt die CLI den von der Authority bereitgestellten Built-in-Client pc_cli. Für eigene Clients (definiert über otherClients in der Authority-Konfiguration) kann die client_id und optional der Scope überschrieben werden:

pc engine login http://localhost:56000 --client-id my-cli-client --scope "openid,profile,engine_read"

Voraussetzung: Der Client ist in der Authority mit grant_types: ["device_code", "refresh_token"] konfiguriert. Details zum Setup: Device Flow (RFC 8628).

Die Scopes werden in der CLI kommagetrennt übergeben und intern in die OAuth-übliche leerzeichengetrennte Form umgewandelt.

Login per Machine-to-Machine-Autorisierung (M2M)

Das Einloggen per M2M ist per --m2m-client-id/--m2m-client-secret möglich:

pc engine login http://localhost:56200 --m2m-client-id $CLIENT_ID --m2m-client-secret $CLIENT_SECRET

Login per Root Access Token

Das Einloggen mittels eines Root Access Tokens ist per --root-access-token möglich:

pc engine login http://localhost:56000 --root-access-token $ROOT_ACCESS_TOKEN

Login per Root-Zugang

Wird eine Engine mit der Standard-Konfiguration gestartet, ist sie auf dem lokalen Rechner ungesichert erreichbar, um einen schnellen Zugang und einfaches Experimentieren zu ermöglichen.

pc engine login http://localhost:56000 --root

Der --root Parameter sollte nur für Development-Umgebungen verwendet werden! Diese Konfigurationsform ist für den Produktionsbetrieb aus Sicherheitsgründen nicht geeignet.