KanBo Powershell-Comandlets

Inhaltsverzeichnis

KanBo konfigurieren

  1. Erstellen eines Paares selbstsignierter Zertifikate
  2. Fügen Sie den folgenden Code in Ihre appsettings.json ein:

{
        "type": "auth.app",
        "issuer": "kanbo-cmdlet",
        "children": [
          {
            "type": "signature",
            "algo": "rs256",
            "children": [
              [
                "cert",
                {
                  "type": "x509-file",
                  "file": "PFX CERT-PATH",
                  "key": "CERT-PASS"
                }
              ]
            ]
          },
          [
            "mapper",
            {
              "type": "user",
              "roles": "security:aad"
            }
          ]
        ]
      },

Ändern Sie „PFX CERT-PATH“ in den Pfad Ihres .pfx-Zertifikats und den „CERT-PASS“ in das Passwort des Zertifikats

  1. Speichern Sie die appsettings.json und KanBo neu

Verwenden des Commandlets

  1. Extrahieren Sie die ZIP-Datei an den gewünschten Speicherort.

Die Commandlet-ZIP-Datei ist nur auf Anfrage erhältlich – bitte kontaktieren Sie uns , um sie zu erhalten.

  1. Importieren Sie das Modul, indem Sie Folgendes ausführen:
Import-Module PATH\KanBo.Cmdlet.dll
  1. Ändern Sie „PATH“ in den Speicherort, an den Sie die ZIP-Datei extrahiert haben.
  2. Verwenden Sie die folgenden Befehle, und stellen Sie sicher, dass Sie die erforderlichen Variablen angeben. Dies sind die wesentlichen Parameter für jeden Befehl, aber es können zusätzliche Optionen verfügbar sein:
  • -CertificatePath (vollständiger Pfad zu Ihrem PFX-Zertifikat)
  • -CertificatePassword (Kennwort Ihres .pfx-Zertifikats)
  • -KanBoUrl (URL Ihres KanBo mit https://)
  • -Issuer (mit dem Wert „KanBo“)
  • -UserId (ID des KanBo , für den die Identität angenommen werden soll)

Liste der Commandlets

Add-Karte

Fügt eine Karte zu einem bestimmten Bereich oder Status hinzu.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • Name (Zeichenfolge) – Erforderlich
  • SpaceId (int) – Optional
  • StatusId (int) – Optional

Ausgang: Keine

Space

Fügt einem Arbeitsbereich einen neuen Bereich hinzu, indem optional ein Microsoft Teams-Kanal erstellt oder angefügt wird.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • WorkspaceId (int) – Erforderlich
  • Name (Zeichenfolge) – Erforderlich
  • ChannelId (Zeichenfolge) – Optional
  • TemplateId (int) – Optional
  • IconColor (int) – Optional
  • Symbol (int) – Optional

Ausgabe: SpaceId (int)

Benutzer hinzufügen

Fügt einen Benutzer zu KanBo hinzu und aktiviert den Benutzer automatisch.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • LoginType (Zeichenfolge) – Erforderlich
  • LoginName (Zeichenfolge) – Erforderlich

Ausgabe: AddedUserId (int)

Arbeitsbereich hinzufügen

Fügt KanBo einen Arbeitsbereich hinzu und erstellt oder fügt optional eine Gruppe/ein Team an.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • Name (Zeichenfolge) – Erforderlich
  • GroupId (Zeichenfolge) – Optional

Ausgabe: WorkspaceId (int)

Space

Schließt einen ausgewählten Bereich basierend auf seiner ID.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • SpaceId (int) – Erforderlich

Ausgang: Keine

Get-SpaceTemplates

Ruft KanBo als Liste ab.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich

Ausgabe: Vorlagen (Liste)

Get-Benutzer

Ruft einen KanBo basierend auf seiner ID ab.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • id (int) – Erforderlich

Ausgabe: Benutzer (Benutzer)

Get-Arbeitsbereich

Ruft einen Arbeitsbereich ab, der auf einer O365-Gruppen-ID basiert.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • GroupId (Zeichenfolge) – Erforderlich

Ausgabe: Arbeitsbereiche (Dictionary<int, string>)

Deaktivieren-Benutzer

Deaktiviert einen Benutzer in KanBo basierend auf seinem Profilschlüssel.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • ProfileKey (Zeichenfolge) – Erforderlich

Ausgang: Keine

Space entfernen

Löscht einen Bereich aus KanBo mit der Option, zugeordnete MS Teams-Ressourcen zu entfernen.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • SpaceId (int) – Erforderlich
  • RemoveResources (bool) – Erforderlich

Ausgang: Keine

Entfernen-SpacesFromWorkspace

Entfernt alle Bereiche aus einem ausgewählten Arbeitsbereich mit der Option, zugeordnete MS Teams-Ressourcen zu entfernen.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • WorkspaceId (int) – Erforderlich
  • RemoveResources (bool) – Erforderlich

Ausgang: Keine

Entfernen-Arbeitsbereich

Entfernt einen Arbeitsbereich aus KanBo mit der Option, zugeordnete MS Teams-Ressourcen zu entfernen.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • WorkspaceId (int) – Erforderlich
  • RemoveResources (bool) – Erforderlich

Ausgang: Keine

Set-UserLicense

Ändert die Lizenz eines Benutzers in einen angegebenen Typ.

Parameter:

  • CertificatePath (Zeichenfolge) – Erforderlich
  • CertificatePassword (Zeichenfolge) – Erforderlich
  • KanBoUrl (Zeichenfolge) – Erforderlich
  • Aussteller (Zeichenfolge) – Erforderlich
  • UserId (int) – Erforderlich
  • id (int) – Erforderlich
  • LicenseType (UserLicenseType) – Erforderlich

Ausgang: Keine

Modelle

BoardTemplate

  • Kennung (int)
  • Name (Zeichenfolge)
  • Position (int)

Benutzer

  • Name (Zeichenfolge)
  • ProfileKey (Zeichenfolge)
  • E-Mail (Zeichenfolge)
  • Aktiv (bool)
  • LicenseType (UserLicenseType)
  • Kennung (int)

UserLicenseType

  • Schriftsteller = 2
  • Leser = 1
  • Keine = 0