Skip to content

Type Alias: AdminClientConfig ​

ts
type AdminClientConfig = Omit<ClientConfig, "auth" | "host"> & object;

Defined in: src/admin/createAdminClient.ts:90

Type Declaration ​

auth ​

ts
auth: AuthBearer;

An organization API key, created under Settings in the organization's own administration.

Nothing else reaches this API. A site API token answers 401 — measured — and so does OAuth 2.0 (3LO), whose scopes are granted by a user for a site rather than by an organization for itself.

host? ​

ts
optional host?: string;

The Atlassian gateway, which is where this API answers rather than on any site's host.

Defaults to https://api.atlassian.com. There is nowhere else to point it; the field exists for a proxy.