|
| 1 | +<!-- -This template file is consumed by the /authorAPIDocs prompt --> |
| 2 | +# RBAC for APIs include file templates |
| 3 | + |
| 4 | +Use these templates when creating RBAC (role-based access control) include files for API operation topics. These files inform callers which Microsoft Entra admin roles are required in delegated scenarios, in addition to Microsoft Graph permissions. |
| 5 | + |
| 6 | +## File conventions |
| 7 | + |
| 8 | +- **Location:** `api-reference/{version}/includes/rbac-for-apis/` |
| 9 | +- **Naming:** `rbac-{feature-area}-apis-{operation}.md` — for example, `rbac-identity-provider-apis.md`, `rbac-access-reviews-apis-read.md` |
| 10 | +- **Placement in API file:** Immediately after the permissions table include statement, before the `## HTTP request` section |
| 11 | + |
| 12 | +### Include syntax in API operation files |
| 13 | + |
| 14 | +```markdown |
| 15 | +[!INCLUDE [rbac-{descriptive-label}](../includes/rbac-for-apis/{filename}.md)] |
| 16 | +``` |
| 17 | + |
| 18 | +--- |
| 19 | + |
| 20 | +## Template A — Single least privileged role |
| 21 | + |
| 22 | +Use when one Entra admin role is the least privileged role for the operation. |
| 23 | + |
| 24 | +```markdown |
| 25 | +--- |
| 26 | +author: {github-username} |
| 27 | +ms.topic: include |
| 28 | +--- |
| 29 | + |
| 30 | +> [!IMPORTANT] |
| 31 | +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *{Role Name}* is the least privileged role supported for this operation. |
| 32 | +``` |
| 33 | + |
| 34 | +### Example (Template A) |
| 35 | + |
| 36 | +```markdown |
| 37 | +--- |
| 38 | +author: janedoe |
| 39 | +ms.topic: include |
| 40 | +--- |
| 41 | + |
| 42 | +> [!IMPORTANT] |
| 43 | +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *External Identity Provider Administrator* is the least privileged role supported for this operation. |
| 44 | +``` |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +## Template B — Multiple least privileged roles |
| 49 | + |
| 50 | +Use when two or more Entra admin roles are supported for the operation, listed from least to most privileged. |
| 51 | + |
| 52 | +```markdown |
| 53 | +--- |
| 54 | +author: {github-username} |
| 55 | +ms.topic: include |
| 56 | +--- |
| 57 | + |
| 58 | +> [!IMPORTANT] |
| 59 | +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. |
| 60 | +> - {Role Name 1} |
| 61 | +> - {Role Name 2} |
| 62 | +> - {Role Name 3} |
| 63 | +``` |
| 64 | + |
| 65 | +### Example (Template B) |
| 66 | + |
| 67 | +```markdown |
| 68 | +--- |
| 69 | +author: janedoe |
| 70 | +ms.topic: include |
| 71 | +--- |
| 72 | + |
| 73 | +> [!IMPORTANT] |
| 74 | +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. |
| 75 | +> - Cloud Application Administrator |
| 76 | +> - Application Administrator |
| 77 | +``` |
0 commit comments