API keys

client.APIKeys lists and streams API key metadata and generates local Ed25519 keypairs. Methods are authenticated and account-scoped.

Methods (API-key SDK)

There is no Create / Update / Delete on this SDK. Creating or revoking keys is a JWT/session product flow (TypeScript / browser).

GenerateKeypair()

pair := client.APIKeys.GenerateKeypair()
// pair.PublicKeyHex / pair.SecretKeyHex, persist secret yourself

List / Get

List and Get need an interactive session token, and this SDK authenticates with an API key only. The server refuses an API key with AUTH_SESSION_KIND_NOT_ALLOWED, which the SDK returns as *errors.SessionRequiredError. List and inspect keys in the Polyester app or with the TypeScript SDK on a session.

keys, err := client.APIKeys.List(ctx, nil, nil)
if sdkerrors.IsSessionRequired(err) {
    log.Fatal("listing API keys needs a session; use the Polyester app")
}
if err != nil { log.Fatal(err) }
for _, key := range keys.Keys {
    fmt.Println(key.KeyID, key.Label, key.Status)
}

Subscribe(ctx, accountID)

Requires the API-key administration read permission and an Account ID. The method returns only after the subscription-token request and Centrifugo handshake succeed.

sub, err := client.APIKeys.Subscribe(ctx, client.DefaultAccountID)
if err != nil { log.Fatal(err) }
defer sub.Close()
for key := range sub.Messages() {
    fmt.Println(key.KeyID, key.Status)
    break
}

Related

• Authentication guide
• Authentication model

Related Topics