Kyvernon

Werkwijze Voor: ontwikkelaars

Portalintegratie

Stel in de console de service principal en het API-token van een self-serviceportal in, en de webhooks die het ontvangt voor tenants en servers.

Een self-serviceportal stuurt Kyvernon aan als service principal: een account voor een programma, met de ingebouwde rol Tenant service principal en een API-token. Deze pagina stelt het account eenmalig in en abonneert de portal op de gebeurtenissen die het nodig heeft. U hebt de bevoegdheden Kyvernon.Identity.ManageUsers, Authorization.ModifyPermissions en Kyvernon.Webhook.Manage nodig op de root.

In de console

De service principal aanmaken

  1. Open Gebruikersmenu rechtsboven, selecteer Beheer en selecteer in de lijst links Gebruikers.

  2. Selecteer Gebruiker maken. Voer Gebruikersnaam in, zoals portal, en Weergavenaam, zoals Self-service portal, en een wachtwoord; het account meldt zich er niet mee aan. Vink Serviceaccount aan.

    Venster Gebruiker maken met wachtwoord en groepen (Groter weergeven)
  3. Selecteer Maken.

De rol toekennen

  1. Selecteer in de lijst links Machtigingen en selecteer in de objectenboom de bovenste vermelding, Beheerdomein.

  2. Selecteer Rol toewijzen. Kies Type principal Gebruiker, zoek portal als Naam van gebruiker of groep en kies de rol Tenant service principal als Rol. Laat Doorgeven aan onderliggende objecten aangevinkt.

    Venster Rol toewijzen met principal, rol en doorgifte (Groter weergeven)
  3. Selecteer Opslaan.

Het API-token aanmaken

  1. Selecteer in de lijst links API-tokens en kies onder Tokens van portal.

  2. Selecteer Token maken, voer Naam in, zoals portal-prod, kies Levensduur en selecteer Token maken.

    Venster API-token maken met naam en levensduur (Groter weergeven)
  3. Selecteer Kopiëren naar klembord, bewaar het geheim in de secretmanager van de portal en selecteer Ik heb het geheim bewaard. Het geheim wordt eenmaal getoond; zie API-tokens.

De portal op gebeurtenissen abonneren

  1. Open de startpagina (Start), selecteer Webhooks onder Snelkoppelingen en selecteer Nieuwe webhook.
  2. Voer Naam in, Adres van de portal en Gedeeld geheim van minimaal 16 tekens.

  3. Laat Tenant leeg om de gebeurtenissen van elke tenant te ontvangen, of voer de id van één tenant in om alleen de gebeurtenissen van die tenant te ontvangen.

    Venster Nieuwe webhook met adres, geheim en gebeurtenistypen (Groter weergeven)
  4. Selecteer Webhook maken en daarna Test versturen om te controleren of de portal antwoordt. Details over het abonnement staan bij Webhooks.

Resultaat

De portal roept de API aan met zijn token en ontvangt deze gebeurtenissen, met het CloudEvents-type kyvernon.event.<type>: server.created, server.deleted, server.resized, server.power, server.reinstalled, tenant.suspended, tenant.resumed, tenant.closed en quota.exceeded. Het veld data.attributes bevat tenant, tenantName, externalRef, server, plan en, waar van toepassing, action. Een abonnement met een tenantfilter ontvangt alleen de gebeurtenissen van die tenant.

Automatisering

Met de CLI

Shell
kyvernon users create portal --display-name "Self-service portal"
kyvernon users service-account portal
kyvernon roles list
kyvernon permissions set group-d1 portal --role <role-id>
kyvernon users api-tokens portal create portal-prod

<role-id> is de id van de rol Tenant service principal in de uitvoer van roles list, en group-d1 is de rootmap. De portal roept daarna de functies voor tenants, plans, catalogus en servers aan; zie Tenants en Servers.

Met de API

Dezelfde stappen zijn POST /v1/identity/users, PUT /v1/identity/users/{username}/service-account, PUT /v1/identity/permissions en POST /v1/identity/users/{username}/api-tokens, en POST /v1/webhooks voor het abonnement.

Versie 0.1. Laatst gewijzigd: 2026-11-14