Authorize API

Forge Authorize API helps app developers verify user permissions before making calls asApp.

Import the Authorize API package in your app, as follows:

1
2
import { authorize } from "@forge/api";

The authorize function returns a number of helper functions that check the current user's permissions to issues, projects, or content. These are convenience methods that call the Jira bulk permissions API and the Confluence content permissions API.

1
2
const canEdit = await authorize().onJiraIssue(issueId).canEditIssues();

if (canEdit) {
  await api.asApp().requestJira(route`/rest/api/3/issue/${issueId}`, {
    method: "PUT",
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ update: { summary: [{ set: "updated summary" }] } }),
  });
}

Method signature

1
2
type Id = number | string;

type authorize = () => {
  onJiraIssue: (issueIds: Id | Id[]) => {
    canAssign: () => Promise<boolean>;
    canCreate: () => Promise<boolean>;
    canEdit: () => Promise<boolean>;
    canMove: () => Promise<boolean>;
    canDelete: () => Promise<boolean>;
    canAddComments: () => Promise<boolean>;
    canEditAllComments: () => Promise<boolean>;
    canDeleteAllComments: () => Promise<boolean>;
    canCreateAttachments: () => Promise<boolean>;
    canDeleteAllAttachments: () => Promise<boolean>;
  };
  onJiraProject: (projectIds: Id | Id[]) => {
    canAssignIssues: () => Promise<boolean>;
    canCreateIssues: () => Promise<boolean>;
    canEditIssues: () => Promise<boolean>;
    canMoveIssues: () => Promise<boolean>;
    canDeleteIssues: () => Promise<boolean>;
    canAddComments: () => Promise<boolean>;
    canEditAllComments: () => Promise<boolean>;
    canDeleteAllComments: () => Promise<boolean>;
    canCreateAttachments: () => Promise<boolean>;
    canDeleteAllAttachments: () => Promise<boolean>;
  };
  onConfluenceContent: (contentIds: Id | Id[]) => {
    canRead: () => Promise<boolean>;
    canUpdate: () => Promise<boolean>;
    canDelete: () => Promise<boolean>;
  };
  // useful for checking permissions of issues and projects in one call
  onJira: (
    perms: Array<{
      permissions: string[];
      issues?: Id[];
      projects?: Id[];
    }>
  ) => Promise<{
    permission: string;
    issues?: number[];
    projects?: number[];
  }>;
};

Parameters