Skip to content

Commit ff261e7

Browse files
KelvinTegelaarKelvinTegelaar
authored
Merge pull request KelvinTegelaar#1618 from HappyEarthDay/feature/update-gdap-api-docs
Update the OpenAPI to include GDAP-related endpoints
2 parents e292d25 + 8b7273f commit ff261e7

File tree

1 file changed

+231
-0
lines changed

1 file changed

+231
-0
lines changed

‎Tools/tenant-openapispec.json‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1617,6 +1617,237 @@
16171617
}
16181618
}
16191619
}
1620+
},
1621+
"/ExecGDAPRoleTemplate": {
1622+
"get": {
1623+
"summary": "List GDAP Role Templates",
1624+
"description": "Retrieves a list of existing GDAP role templates",
1625+
"tags": [
1626+
"Tenant Administration"
1627+
],
1628+
"responses": {
1629+
"200": {
1630+
"description": "GDAP role templates retrieved successfully",
1631+
"content": {
1632+
"application/json": {
1633+
"schema": {
1634+
"type": "object",
1635+
"properties": {
1636+
"Results": {
1637+
"type": "array",
1638+
"items": {
1639+
"type": "object",
1640+
"properties": {
1641+
"TemplateId": {
1642+
"type": "string",
1643+
"description": "Unique identifier for the template"
1644+
},
1645+
"RoleMappings": {
1646+
"type": "array",
1647+
"description": "List of role mappings in the template",
1648+
"items": {
1649+
"type": "object",
1650+
"properties": {
1651+
"GroupName": {
1652+
"type": "string",
1653+
"description": "Name of the GDAP group"
1654+
},
1655+
"GroupId": {
1656+
"type": "string",
1657+
"description": "Unique identifier for the GDAP group"
1658+
},
1659+
"RoleName": {
1660+
"type": "string",
1661+
"description": "Name of the Microsoft role"
1662+
},
1663+
"roleDefinitionId": {
1664+
"type": "string",
1665+
"description": "Unique identifier for the role definition"
1666+
}
1667+
}
1668+
}
1669+
}
1670+
}
1671+
}
1672+
},
1673+
"Metadata": {
1674+
"type": "object",
1675+
"properties": {
1676+
"Count": {
1677+
"type": "integer",
1678+
"description": "Number of templates returned"
1679+
}
1680+
}
1681+
}
1682+
}
1683+
}
1684+
}
1685+
}
1686+
},
1687+
"400": {
1688+
"description": "Bad request"
1689+
},
1690+
"401": {
1691+
"description": "Unauthorized"
1692+
},
1693+
"500": {
1694+
"description": "Internal server error"
1695+
}
1696+
}
1697+
}
1698+
},
1699+
"/ListGDAPRoles": {
1700+
"get": {
1701+
"summary": "List GDAP Roles",
1702+
"description": "Retrieves a list of GDAP roles that have been mapped in CIPP",
1703+
"tags": [
1704+
"Tenant Administration"
1705+
],
1706+
"responses": {
1707+
"200": {
1708+
"description": "GDAP roles retrieved successfully",
1709+
"content": {
1710+
"application/json": {
1711+
"schema": {
1712+
"type": "array",
1713+
"items": {
1714+
"type": "object",
1715+
"properties": {
1716+
"GroupName": {
1717+
"type": "string",
1718+
"description": "Name of the GDAP group"
1719+
},
1720+
"GroupId": {
1721+
"type": "string",
1722+
"description": "Unique identifier for the GDAP group"
1723+
},
1724+
"RoleName": {
1725+
"type": "string",
1726+
"description": "Name of the Microsoft role"
1727+
},
1728+
"roleDefinitionId": {
1729+
"type": "string",
1730+
"description": "Unique identifier for the role definition"
1731+
}
1732+
}
1733+
}
1734+
}
1735+
}
1736+
}
1737+
},
1738+
"400": {
1739+
"description": "Bad request"
1740+
},
1741+
"401": {
1742+
"description": "Unauthorized"
1743+
},
1744+
"500": {
1745+
"description": "Internal server error"
1746+
}
1747+
}
1748+
}
1749+
},
1750+
"/ExecGDAPInvite": {
1751+
"post": {
1752+
"summary": "Create GDAP Invite",
1753+
"description": "Creates a GDAP invite using the specified role mappings",
1754+
"tags": [
1755+
"Tenant Administration"
1756+
],
1757+
"requestBody": {
1758+
"required": true,
1759+
"content": {
1760+
"application/json": {
1761+
"schema": {
1762+
"type": "object",
1763+
"required": [
1764+
"roleMappings"
1765+
],
1766+
"properties": {
1767+
"roleMappings": {
1768+
"type": "array",
1769+
"description": "List of role mappings for the GDAP invite",
1770+
"items": {
1771+
"type": "object",
1772+
"properties": {
1773+
"GroupName": {
1774+
"type": "string",
1775+
"description": "Name of the GDAP group"
1776+
},
1777+
"GroupId": {
1778+
"type": "string",
1779+
"description": "Unique identifier for the GDAP group"
1780+
},
1781+
"RoleName": {
1782+
"type": "string",
1783+
"description": "Name of the Microsoft role"
1784+
},
1785+
"roleDefinitionId": {
1786+
"type": "string",
1787+
"description": "Unique identifier for the role definition"
1788+
}
1789+
}
1790+
}
1791+
}
1792+
}
1793+
}
1794+
}
1795+
}
1796+
},
1797+
"responses": {
1798+
"200": {
1799+
"description": "GDAP invite created successfully",
1800+
"content": {
1801+
"application/json": {
1802+
"schema": {
1803+
"type": "object",
1804+
"properties": {
1805+
"Message": {
1806+
"type": "string",
1807+
"description": "Success message"
1808+
},
1809+
"Invite": {
1810+
"type": "object",
1811+
"properties": {
1812+
"PartitionKey": {
1813+
"type": "string",
1814+
"description": "Partition key for the invite"
1815+
},
1816+
"RowKey": {
1817+
"type": "string",
1818+
"description": "Unique identifier for the invite"
1819+
},
1820+
"InviteUrl": {
1821+
"type": "string",
1822+
"description": "URL for accepting the GDAP invite"
1823+
},
1824+
"OnboardingUrl": {
1825+
"type": "string",
1826+
"nullable": true,
1827+
"description": "Onboarding URL if available"
1828+
},
1829+
"RoleMappings": {
1830+
"type": "string",
1831+
"description": "JSON string of role mappings"
1832+
}
1833+
}
1834+
}
1835+
}
1836+
}
1837+
}
1838+
}
1839+
},
1840+
"400": {
1841+
"description": "Bad request"
1842+
},
1843+
"401": {
1844+
"description": "Unauthorized"
1845+
},
1846+
"500": {
1847+
"description": "Internal server error"
1848+
}
1849+
}
1850+
}
16201851
}
16211852
}
16221853
}

0 commit comments

Comments
 (0)