jira.js
    Preparing search index...

    Function getDomainById

    • Returns information about a single verified domain by ID.

      Authorization scopes required: read:domains:admin

      Parameters

      • client: Client
      • parameters: { domainId: string; orgId: string }
        • domainId: string

          ID of the domain to return

        • orgId: string

          Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              data?: {
                  attributes: {
                      claim?: {
                          status?: | "deleted"
                          | string & {}
                          | "verified"
                          | "unverified"
                          | "superseded"
                          | "missing_token";
                          type?: string & {}
                          | "http"
                          | "dns";
                          [key: string]: unknown;
                      };
                      name?: string;
                      [key: string]: unknown;
                  };
                  id: string;
                  links: { self: string
                  | null; [key: string]: unknown };
                  type: string & {} | "domains";
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility

    On This Page
    Scopes