Interface: TenantContext

Defined in: src/core/tenantContext.ts:16

The identifiers Atlassian's platform APIs address a site by.

A site has three names, and which one an API wants depends on the API. cloudId addresses the site itself and is what https://api.atlassian.com/ex/jira/{cloudId} is built from. orgId addresses the organization the site belongs to, which is a level above it — several sites can share one — and is what the Teams API takes. hostName is the site URL without its scheme.

Properties

cloudId

cloudId: string;

Defined in: src/core/tenantContext.ts:18

Addresses the site. One per site.

---

hostName

hostName: string;

Defined in: src/core/tenantContext.ts:22

The site's host, e.g. your-domain.atlassian.net.

---

orgId

orgId: string;

Defined in: src/core/tenantContext.ts:20

Addresses the organization the site belongs to. Shared by every site in it.