@pulumi/tailscale
Version:
A Pulumi package for creating and managing Tailscale cloud resources.
33 lines (32 loc) • 2.03 kB
TypeScript
/**
* The API key to use for authenticating requests to the API. Can be set via the TAILSCALE_API_KEY environment variable. Conflicts with 'oauth_client_id' and 'oauth_client_secret'.
*/
export declare const apiKey: string | undefined;
/**
* The base URL of the Tailscale API. Defaults to https://api.tailscale.com. Can be set via the TAILSCALE_BASE_URL environment variable.
*/
export declare const baseUrl: string | undefined;
/**
* The jwt identity token to exchange for a Tailscale API token when using a federated identity client. Can be set via the TAILSCALE_IDENTITY_TOKEN environment variable. Conflicts with 'api_key' and 'oauth_client_secret'.
*/
export declare const identityToken: string | undefined;
/**
* The OAuth application's ID when using OAuth client credentials. Can be set via the TAILSCALE_OAUTH_CLIENT_ID environment variable. Either 'oauth_client_secret' or 'identity_token' must be set alongside 'oauth_client_id'. Conflicts with 'api_key'.
*/
export declare const oauthClientId: string | undefined;
/**
* The OAuth application's secret when using OAuth client credentials. Can be set via the TAILSCALE_OAUTH_CLIENT_SECRET environment variable. Conflicts with 'api_key' and 'identity_token'.
*/
export declare const oauthClientSecret: string | undefined;
/**
* The OAuth 2.0 scopes to request when generating the access token using the supplied OAuth client credentials. See https://tailscale.com/kb/1215/oauth-clients/#scopes for available scopes. Only valid when both 'oauth_client_id' and 'oauth_client_secret' are set.
*/
export declare const scopes: string[] | undefined;
/**
* The tailnet ID. Tailnets created before Oct 2025 can still use the legacy ID, but the Tailnet ID is the preferred identifier. Can be set via the TAILSCALE_TAILNET environment variable. Default is the tailnet that owns API credentials passed to the provider.
*/
export declare const tailnet: string | undefined;
/**
* User-Agent header for API requests.
*/
export declare const userAgent: string | undefined;