jira.js
    Preparing search index...

    Interface TenantContext

    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.

    interface TenantContext {
        cloudId: string;
        hostName: string;
        orgId: string;
    }
    Index
    cloudId hostName orgId
    cloudId: string

    Addresses the site. One per site.

    hostName: string

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

    orgId: string

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

    Settings
    Member Visibility

    On This Page
    Properties