Security callbacks

Instead of providing credentials once during SDK instantiation, you can pass a custom authentication function that allows end users to manage secrets dynamically. Custom authentication functions can be used to automatically refresh tokens or retrieve secrets from a secret store.

Language support

TypeScript	Python	Go	C#	Java	PHP	Swift	Ruby
✅	✅	✅	✅️	✅	🏗️	🏗️	🏗️

Example: Bearer authentication

In this example, bearer authentication is used as the only security scheme:

security:
  - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

The callback function passed when initializing the SDK acts as a security source and is called whenever a request is made, allowing tokens to be refreshed if needed.

import { SDK } from "<packageName>";
import { Security } from "<packageName>/models";

const sdk = new SDK({
  security: async (): Promise<Security> => {
    // refresh token here
    const token = "<YOUR_JWT>";
    return { bearerAuth: token };
  },
});

import requests
import sdk
from sdk.components import Security

def callback() -> Security:
    # refresh token here
    token = "<YOUR_JWT>"
    return Security(bearer_auth=token)

s = sdk.SDK(security=with_authorization(callback))

import (
	"context"
  sdk "speakeasy"
	"speakeasy/components"
)

s := sdk.New(
    sdk.WithSecuritySource(func(ctx context.Context) (components.Security, error) {
        // refresh token here
        token := "<YOUR_JWT>"
        return components.Security{BearerAuth: token}, nil
    }),
)

import dev.speakeasyapi.speakeasy.SDK;
import dev.speakeasyapi.speakeasy.SecuritySource;
import dev.speakeasyapi.speakeasy.models.components.Security;


class BearerSource implements SecuritySource {

    public Security getSecurity() {
        // refresh token here
        return Security.builder()
            .bearerAuth("<YOUR_JWT>")
            .build();
    }
}

import dev.speakeasyapi.speakeasy.SDK;
import dev.speakeasyapi.speakeasy.SecuritySource;
import dev.speakeasyapi.speakeasy.models.components.Security;

SDK s = SDK.builder()
    .securitySource(new BearerSource())
    .build();

using Speakeasy;
using Speakeasy.Models.Components;


Func<Security> tokenSource = () =>
{
    // refresh token here
    var token = "<YOUR_JWT>"

    return new Security { BearerAuth = token}
}

var sdk = new SDK(securitySource: tokenSource);