1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import typing as ty
import openstack.exceptions as exception
from openstack.identity.v3 import (
application_credential as _application_credential,
)
from openstack.identity.v3 import access_rule as _access_rule
from openstack.identity.v3 import credential as _credential
from openstack.identity.v3 import domain as _domain
from openstack.identity.v3 import domain_config as _domain_config
from openstack.identity.v3 import endpoint as _endpoint
from openstack.identity.v3 import federation_protocol as _federation_protocol
from openstack.identity.v3 import group as _group
from openstack.identity.v3 import identity_provider as _identity_provider
from openstack.identity.v3 import limit as _limit
from openstack.identity.v3 import mapping as _mapping
from openstack.identity.v3 import policy as _policy
from openstack.identity.v3 import project as _project
from openstack.identity.v3 import region as _region
from openstack.identity.v3 import registered_limit as _registered_limit
from openstack.identity.v3 import role as _role
from openstack.identity.v3 import role_assignment as _role_assignment
from openstack.identity.v3 import (
role_domain_group_assignment as _role_domain_group_assignment,
)
from openstack.identity.v3 import (
role_domain_user_assignment as _role_domain_user_assignment,
)
from openstack.identity.v3 import (
role_project_group_assignment as _role_project_group_assignment,
)
from openstack.identity.v3 import (
role_project_user_assignment as _role_project_user_assignment,
)
from openstack.identity.v3 import (
role_system_group_assignment as _role_system_group_assignment,
)
from openstack.identity.v3 import (
role_system_user_assignment as _role_system_user_assignment,
)
from openstack.identity.v3 import service as _service
from openstack.identity.v3 import service_provider as _service_provider
from openstack.identity.v3 import system as _system
from openstack.identity.v3 import trust as _trust
from openstack.identity.v3 import user as _user
from openstack import proxy
from openstack import resource
from openstack import utils
class Proxy(proxy.Proxy):
_resource_registry = {
"application_credential": _application_credential.ApplicationCredential, # noqa: E501
"access_rule": _access_rule.AccessRule,
"credential": _credential.Credential,
"domain": _domain.Domain,
"endpoint": _endpoint.Endpoint,
"federation_protocol": _federation_protocol.FederationProtocol,
"group": _group.Group,
"identity_provider": _identity_provider.IdentityProvider,
"limit": _limit.Limit,
"mapping": _mapping.Mapping,
"policy": _policy.Policy,
"project": _project.Project,
"region": _region.Region,
"registered_limit": _registered_limit.RegisteredLimit,
"role": _role.Role,
"role_assignment": _role_assignment.RoleAssignment,
"role_domain_group_assignment": _role_domain_group_assignment.RoleDomainGroupAssignment, # noqa: E501
"role_domain_user_assignment": _role_domain_user_assignment.RoleDomainUserAssignment, # noqa: E501
"role_project_group_assignment": _role_project_group_assignment.RoleProjectGroupAssignment, # noqa: E501
"role_project_user_assignment": _role_project_user_assignment.RoleProjectUserAssignment, # noqa: E501
"role_system_group_assignment": _role_system_group_assignment.RoleSystemGroupAssignment, # noqa: E501
"role_system_user_assignment": _role_system_user_assignment.RoleSystemUserAssignment, # noqa: E501
"service": _service.Service,
"system": _system.System,
"trust": _trust.Trust,
"user": _user.User,
}
# ========== Credentials ==========
def create_credential(self, **attrs):
"""Create a new credential from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.credential.Credential`,
comprised of the properties on the Credential class.
:returns: The results of credential creation
:rtype: :class:`~openstack.identity.v3.credential.Credential`
"""
return self._create(_credential.Credential, **attrs)
def delete_credential(self, credential, ignore_missing=True):
"""Delete a credential
:param credential: The value can be either the ID of a credential or a
:class:`~openstack.identity.v3.credential.Credential` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the credential does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent credential.
:returns: ``None``
"""
self._delete(
_credential.Credential, credential, ignore_missing=ignore_missing
)
def find_credential(self, name_or_id, ignore_missing=True):
"""Find a single credential
:param name_or_id: The name or ID of a credential.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.credential.Credential`
or None
"""
return self._find(
_credential.Credential, name_or_id, ignore_missing=ignore_missing
)
def get_credential(self, credential):
"""Get a single credential
:param credential: The value can be the ID of a credential or a
:class:`~openstack.identity.v3.credential.Credential` instance.
:returns: One :class:`~openstack.identity.v3.credential.Credential`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_credential.Credential, credential)
def credentials(self, **query):
"""Retrieve a generator of credentials
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of credentials instances.
:rtype: :class:`~openstack.identity.v3.credential.Credential`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_credential.Credential, **query)
def update_credential(self, credential, **attrs):
"""Update a credential
:param credential: Either the ID of a credential or a
:class:`~openstack.identity.v3.credential.Credential` instance.
:param attrs: The attributes to update on the credential represented
by ``credential``.
:returns: The updated credential
:rtype: :class:`~openstack.identity.v3.credential.Credential`
"""
return self._update(_credential.Credential, credential, **attrs)
# ========== Domains ==========
def create_domain(self, **attrs):
"""Create a new domain from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.domain.Domain`,
comprised of the properties on the Domain class.
:returns: The results of domain creation
:rtype: :class:`~openstack.identity.v3.domain.Domain`
"""
return self._create(_domain.Domain, **attrs)
def delete_domain(self, domain, ignore_missing=True):
"""Delete a domain
:param domain: The value can be either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the domain does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent domain.
:returns: ``None``
"""
self._delete(_domain.Domain, domain, ignore_missing=ignore_missing)
def find_domain(self, name_or_id, ignore_missing=True):
"""Find a single domain
:param name_or_id: The name or ID of a domain.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.domain.Domain` or None
"""
return self._find(
_domain.Domain, name_or_id, ignore_missing=ignore_missing
)
def get_domain(self, domain):
"""Get a single domain
:param domain: The value can be the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:returns: One :class:`~openstack.identity.v3.domain.Domain`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_domain.Domain, domain)
def domains(self, **query):
"""Retrieve a generator of domains
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of domain instances.
:rtype: :class:`~openstack.identity.v3.domain.Domain`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_domain.Domain, **query)
def update_domain(self, domain, **attrs):
"""Update a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param attrs: The attributes to update on the domain represented
by ``domain``.
:returns: The updated domain
:rtype: :class:`~openstack.identity.v3.domain.Domain`
"""
return self._update(_domain.Domain, domain, **attrs)
# ========== Domain configs ==========
def create_domain_config(self, domain, **attrs):
"""Create a new config for a domain from attributes.
:param domain: The value can be the ID of a domain or
a :class:`~openstack.identity.v3.domain.Domain` instance.
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.identity.v3.domain_config.DomainConfig`
comprised of the properties on the DomainConfig class.
:returns: The results of domain config creation
:rtype: :class:`~openstack.identity.v3.domain_config.DomainConfig`
"""
domain_id = resource.Resource._get_id(domain)
return self._create(
_domain_config.DomainConfig,
domain_id=domain_id,
**attrs,
)
def delete_domain_config(self, domain, ignore_missing=True):
"""Delete a config for a domain
:param domain: The value can be the ID of a domain or a
a :class:`~openstack.identity.v3.domain.Domain` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the identity provider does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent config for a domain.
:returns: ``None``
"""
domain_id = resource.Resource._get_id(domain)
self._delete(
_domain_config.DomainConfig,
None,
domain_id=domain_id,
ignore_missing=ignore_missing,
)
def get_domain_config(self, domain):
"""Get a single config for a domain
:param domain_id: The value can be the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:returns: One
:class:`~openstack.identity.v3.domain_config.DomainConfig`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
domain_id = resource.Resource._get_id(domain)
return self._get(
_domain_config.DomainConfig,
domain_id=domain_id,
requires_id=False,
)
def update_domain_config(self, domain, **attrs):
"""Update a config for a domain
:param domain_id: The value can be the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param attrs: The attributes to update on the config for a domain
represented by ``domain_id``.
:returns: The updated config for a domain
:rtype: :class:`~openstack.identity.v3.domain_config.DomainConfig`
"""
domain_id = resource.Resource._get_id(domain)
return self._update(
_domain_config.DomainConfig,
None,
domain_id=domain_id,
**attrs,
)
# ========== Endpoints ==========
def create_endpoint(self, **attrs):
"""Create a new endpoint from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.endpoint.Endpoint`,
comprised of the properties on the Endpoint class.
:returns: The results of endpoint creation
:rtype: :class:`~openstack.identity.v3.endpoint.Endpoint`
"""
return self._create(_endpoint.Endpoint, **attrs)
def delete_endpoint(self, endpoint, ignore_missing=True):
"""Delete an endpoint
:param endpoint: The value can be either the ID of an endpoint or a
:class:`~openstack.identity.v3.endpoint.Endpoint` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the endpoint does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent endpoint.
:returns: ``None``
"""
self._delete(
_endpoint.Endpoint, endpoint, ignore_missing=ignore_missing
)
def find_endpoint(self, name_or_id, ignore_missing=True):
"""Find a single endpoint
:param name_or_id: The name or ID of a endpoint.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.endpoint.Endpoint` or None
"""
return self._find(
_endpoint.Endpoint, name_or_id, ignore_missing=ignore_missing
)
# TODO(stephenfin): This conflicts with Adapter.get_endpoint
def get_endpoint(self, endpoint): # type: ignore[override]
"""Get a single endpoint
:param endpoint: The value can be the ID of an endpoint or a
:class:`~openstack.identity.v3.endpoint.Endpoint`
instance.
:returns: One :class:`~openstack.identity.v3.endpoint.Endpoint`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_endpoint.Endpoint, endpoint)
def endpoints(self, **query):
"""Retrieve a generator of endpoints
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of endpoint instances.
:rtype: :class:`~openstack.identity.v3.endpoint.Endpoint`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_endpoint.Endpoint, **query)
def update_endpoint(self, endpoint, **attrs):
"""Update a endpoint
:param endpoint: Either the ID of an endpoint or a
:class:`~openstack.identity.v3.endpoint.Endpoint` instance.
:param attrs: The attributes to update on the endpoint represented
by ``endpoint``.
:returns: The updated endpoint
:rtype: :class:`~openstack.identity.v3.endpoint.Endpoint`
"""
return self._update(_endpoint.Endpoint, endpoint, **attrs)
# ========== Project endpoints ==========
def project_endpoints(self, project, **query):
"""Retrieve a generator of endpoints which are associated with the
project.
:param project: Either the project ID or an instance of
:class:`~openstack.identity.v3.project.Project`
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of endpoint instances.
:rtype: :class:`~openstack.identity.v3.endpoint.ProjectEndpoint`
"""
project_id = self._get_resource(_project.Project, project).id
return self._list(
_endpoint.ProjectEndpoint, project_id=project_id, **query
)
def associate_endpoint_with_project(self, project, endpoint):
"""Creates a direct association between project and endpoint
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project` instance.
:param endpoint: Either the ID of an endpoint or a
:class:`~openstack.identity.v3.endpoint.Endpoint` instance.
:returns: None
"""
project = self._get_resource(_project.Project, project)
endpoint = self._get_resource(_endpoint.Endpoint, endpoint)
project.associate_endpoint(self, endpoint.id)
def disassociate_endpoint_from_project(self, project, endpoint):
"""Removes a direct association between project and endpoint
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project` instance.
:param endpoint: Either the ID of an endpoint or a
:class:`~openstack.identity.v3.endpoint.Endpoint` instance.
:returns: None
"""
project = self._get_resource(_project.Project, project)
endpoint = self._get_resource(_endpoint.Endpoint, endpoint)
project.disassociate_endpoint(self, endpoint.id)
# ========== Groups ==========
def create_group(self, **attrs):
"""Create a new group from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.group.Group`,
comprised of the properties on the Group class.
:returns: The results of group creation
:rtype: :class:`~openstack.identity.v3.group.Group`
"""
return self._create(_group.Group, **attrs)
def delete_group(self, group, ignore_missing=True):
"""Delete a group
:param group: The value can be either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the group does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent group.
:returns: ``None``
"""
self._delete(_group.Group, group, ignore_missing=ignore_missing)
def find_group(self, name_or_id, ignore_missing=True, **query):
"""Find a single group
:param name_or_id: The name or ID of a group.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.group.Group` or None
"""
return self._find(
_group.Group,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_group(self, group):
"""Get a single group
:param group: The value can be the ID of a group or a
:class:`~openstack.identity.v3.group.Group`
instance.
:returns: One :class:`~openstack.identity.v3.group.Group`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_group.Group, group)
def groups(self, **query):
"""Retrieve a generator of groups
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of group instances.
:rtype: :class:`~openstack.identity.v3.group.Group`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_group.Group, **query)
def update_group(self, group, **attrs):
"""Update a group
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param attrs: The attributes to update on the group represented
by ``group``.
:returns: The updated group
:rtype: :class:`~openstack.identity.v3.group.Group`
"""
return self._update(_group.Group, group, **attrs)
def add_user_to_group(self, user, group):
"""Add user to group
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:return: ``None``
"""
user = self._get_resource(_user.User, user)
group = self._get_resource(_group.Group, group)
group.add_user(self, user)
def remove_user_from_group(self, user, group):
"""Remove user to group
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:return: ``None``
"""
user = self._get_resource(_user.User, user)
group = self._get_resource(_group.Group, group)
group.remove_user(self, user)
def check_user_in_group(self, user, group):
"""Check whether user belongsto group
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:return: A boolean representing current relation
"""
user = self._get_resource(_user.User, user)
group = self._get_resource(_group.Group, group)
return group.check_user(self, user)
def group_users(self, group, **attrs):
"""List users in a group
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param attrs: Only password_expires_at can be filter for result.
:return: List of :class:`~openstack.identity.v3.user.User`
"""
group = self._get_resource(_group.Group, group)
base_path = utils.urljoin(group.base_path, group.id, 'users')
users = self._list(_user.User, base_path=base_path, **attrs)
return users
# ========== Policies ==========
def create_policy(self, **attrs):
"""Create a new policy from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.policy.Policy`,
comprised of the properties on the Policy class.
:returns: The results of policy creation
:rtype: :class:`~openstack.identity.v3.policy.Policy`
"""
return self._create(_policy.Policy, **attrs)
def delete_policy(self, policy, ignore_missing=True):
"""Delete a policy
:param policy: The value can be either the ID of a policy or a
:class:`~openstack.identity.v3.policy.Policy` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the policy does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent policy.
:returns: ``None``
"""
self._delete(_policy.Policy, policy, ignore_missing=ignore_missing)
def find_policy(self, name_or_id, ignore_missing=True):
"""Find a single policy
:param name_or_id: The name or ID of a policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.policy.Policy` or None
"""
return self._find(
_policy.Policy, name_or_id, ignore_missing=ignore_missing
)
def get_policy(self, policy):
"""Get a single policy
:param policy: The value can be the ID of a policy or a
:class:`~openstack.identity.v3.policy.Policy` instance.
:returns: One :class:`~openstack.identity.v3.policy.Policy`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_policy.Policy, policy)
def policies(self, **query):
"""Retrieve a generator of policies
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of policy instances.
:rtype: :class:`~openstack.identity.v3.policy.Policy`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_policy.Policy, **query)
def update_policy(self, policy, **attrs):
"""Update a policy
:param policy: Either the ID of a policy or a
:class:`~openstack.identity.v3.policy.Policy` instance.
:param attrs: The attributes to update on the policy represented
by ``policy``.
:returns: The updated policy
:rtype: :class:`~openstack.identity.v3.policy.Policy`
"""
return self._update(_policy.Policy, policy, **attrs)
# ========== Project ==========
def create_project(self, **attrs):
"""Create a new project from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.project.Project`,
comprised of the properties on the Project class.
:returns: The results of project creation
:rtype: :class:`~openstack.identity.v3.project.Project`
"""
return self._create(_project.Project, **attrs)
def delete_project(self, project, ignore_missing=True):
"""Delete a project
:param project: The value can be either the ID of a project or a
:class:`~openstack.identity.v3.project.Project` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the project does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent project.
:returns: ``None``
"""
self._delete(_project.Project, project, ignore_missing=ignore_missing)
def find_project(self, name_or_id, ignore_missing=True, **query):
"""Find a single project
:param name_or_id: The name or ID of a project.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.project.Project` or None
"""
return self._find(
_project.Project,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_project(self, project):
"""Get a single project
:param project: The value can be the ID of a project or a
:class:`~openstack.identity.v3.project.Project` instance.
:returns: One :class:`~openstack.identity.v3.project.Project`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_project.Project, project)
def projects(self, **query):
"""Retrieve a generator of projects
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of project instances.
:rtype: :class:`~openstack.identity.v3.project.Project`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_project.Project, **query)
def user_projects(self, user, **query):
"""Retrieve a generator of projects to which the user has authorization
to access.
:param user: Either the user id or an instance of
:class:`~openstack.identity.v3.user.User`
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of project instances.
:rtype: :class:`~openstack.identity.v3.project.UserProject`
"""
user = self._get_resource(_user.User, user)
return self._list(_project.UserProject, user_id=user.id, **query)
def endpoint_projects(self, endpoint, **query):
"""Retrieve a generator of projects which are associated with the
endpoint.
:param endpoint: Either the endpoint ID or an instance of
:class:`~openstack.identity.v3.endpoint.Endpoint`
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of project instances.
:rtype: :class:`~openstack.identity.v3.project.EndpointProject`
"""
endpoint_id = self._get_resource(_endpoint.Endpoint, endpoint).id
return self._list(
_project.EndpointProject, endpoint_id=endpoint_id, **query
)
def update_project(self, project, **attrs):
"""Update a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project` instance.
:param attrs: The attributes to update on the project represented
by ``project``.
:returns: The updated project
:rtype: :class:`~openstack.identity.v3.project.Project`
"""
return self._update(_project.Project, project, **attrs)
# ========== Services ==========
def create_service(self, **attrs):
"""Create a new service from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.service.Service`,
comprised of the properties on the Service class.
:returns: The results of service creation
:rtype: :class:`~openstack.identity.v3.service.Service`
"""
return self._create(_service.Service, **attrs)
def delete_service(self, service, ignore_missing=True):
"""Delete a service
:param service: The value can be either the ID of a service or a
:class:`~openstack.identity.v3.service.Service` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the service does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent service.
:returns: ``None``
"""
self._delete(_service.Service, service, ignore_missing=ignore_missing)
def find_service(self, name_or_id, ignore_missing=True):
"""Find a single service
:param name_or_id: The name or ID of a service.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.service.Service` or None
"""
return self._find(
_service.Service, name_or_id, ignore_missing=ignore_missing
)
def get_service(self, service):
"""Get a single service
:param service: The value can be the ID of a service or a
:class:`~openstack.identity.v3.service.Service` instance.
:returns: One :class:`~openstack.identity.v3.service.Service`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_service.Service, service)
def services(self, **query):
"""Retrieve a generator of services
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of service instances.
:rtype: :class:`~openstack.identity.v3.service.Service`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_service.Service, **query)
def update_service(self, service, **attrs):
"""Update a service
:param service: Either the ID of a service or a
:class:`~openstack.identity.v3.service.Service` instance.
:param attrs: The attributes to update on the service represented
by ``service``.
:returns: The updated service
:rtype: :class:`~openstack.identity.v3.service.Service`
"""
return self._update(_service.Service, service, **attrs)
# ========== Users ==========
def create_user(self, **attrs):
"""Create a new user from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.user.User`,
comprised of the properties on the User class.
:returns: The results of user creation
:rtype: :class:`~openstack.identity.v3.user.User`
"""
return self._create(_user.User, **attrs)
def delete_user(self, user, ignore_missing=True):
"""Delete a user
:param user: The value can be either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the user does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent user.
:returns: ``None``
"""
self._delete(_user.User, user, ignore_missing=ignore_missing)
def find_user(self, name_or_id, ignore_missing=True, **query):
"""Find a single user
:param name_or_id: The name or ID of a user.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.user.User` or None
"""
return self._find(
_user.User,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_user(self, user):
"""Get a single user
:param user: The value can be the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:returns: One :class:`~openstack.identity.v3.user.User`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_user.User, user)
def user_groups(self, user):
"""List groups a user is in
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance
:return: List of :class:`~openstack.identity.v3.group.group`
"""
user_id = self._get_resource(_user.User, user).id
groups = self._list(_group.UserGroup, user_id=user_id)
return groups
def users(self, **query):
"""Retrieve a generator of users
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of user instances.
:rtype: :class:`~openstack.identity.v3.user.User`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_user.User, **query)
def update_user(self, user, **attrs):
"""Update a user
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param attrs: The attributes to update on the user represented
by ``attrs``.
:returns: The updated user
:rtype: :class:`~openstack.identity.v3.user.User`
"""
return self._update(_user.User, user, **attrs)
# ========== Trusts ==========
def create_trust(self, **attrs):
"""Create a new trust from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.trust.Trust`,
comprised of the properties on the Trust class.
:returns: The results of trust creation
:rtype: :class:`~openstack.identity.v3.trust.Trust`
"""
return self._create(_trust.Trust, **attrs)
def delete_trust(self, trust, ignore_missing=True):
"""Delete a trust
:param trust: The value can be either the ID of a trust or a
:class:`~openstack.identity.v3.trust.Trust` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the credential does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent credential.
:returns: ``None``
"""
self._delete(_trust.Trust, trust, ignore_missing=ignore_missing)
def find_trust(self, name_or_id, ignore_missing=True):
"""Find a single trust
:param name_or_id: The name or ID of a trust.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.trust.Trust` or None
"""
return self._find(
_trust.Trust, name_or_id, ignore_missing=ignore_missing
)
def get_trust(self, trust):
"""Get a single trust
:param trust: The value can be the ID of a trust or a
:class:`~openstack.identity.v3.trust.Trust` instance.
:returns: One :class:`~openstack.identity.v3.trust.Trust`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_trust.Trust, trust)
def trusts(self, **query):
"""Retrieve a generator of trusts
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of trust instances.
:rtype: :class:`~openstack.identity.v3.trust.Trust`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_trust.Trust, **query)
# ========== Regions ==========
def create_region(self, **attrs):
"""Create a new region from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.region.Region`,
comprised of the properties on the Region class.
:returns: The results of region creation.
:rtype: :class:`~openstack.identity.v3.region.Region`
"""
return self._create(_region.Region, **attrs)
def delete_region(self, region, ignore_missing=True):
"""Delete a region
:param region: The value can be either the ID of a region or a
:class:`~openstack.identity.v3.region.Region` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the region does not exist.
When set to ``True``, no exception will be thrown when
attempting to delete a nonexistent region.
:returns: ``None``
"""
self._delete(_region.Region, region, ignore_missing=ignore_missing)
def find_region(self, name_or_id, ignore_missing=True):
"""Find a single region
:param name_or_id: The name or ID of a region.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the region does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent region.
:returns: One :class:`~openstack.identity.v3.region.Region` or None
"""
return self._find(
_region.Region, name_or_id, ignore_missing=ignore_missing
)
def get_region(self, region):
"""Get a single region
:param region: The value can be the ID of a region or a
:class:`~openstack.identity.v3.region.Region` instance.
:returns: One :class:`~openstack.identity.v3.region.Region`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no matching region can be found.
"""
return self._get(_region.Region, region)
def regions(self, **query):
"""Retrieve a generator of regions
:param kwargs query: Optional query parameters to be sent to limit
the regions being returned.
:returns: A generator of region instances.
:rtype: :class:`~openstack.identity.v3.region.Region`
"""
# TODO(briancurtin): This is paginated but requires base list changes.
return self._list(_region.Region, **query)
def update_region(self, region, **attrs):
"""Update a region
:param region: Either the ID of a region or a
:class:`~openstack.identity.v3.region.Region` instance.
:param attrs: The attributes to update on the region represented
by ``region``.
:returns: The updated region.
:rtype: :class:`~openstack.identity.v3.region.Region`
"""
return self._update(_region.Region, region, **attrs)
# ========== Roles ==========
def create_role(self, **attrs):
"""Create a new role from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.role.Role`,
comprised of the properties on the Role class.
:returns: The results of role creation.
:rtype: :class:`~openstack.identity.v3.role.Role`
"""
return self._create(_role.Role, **attrs)
def delete_role(self, role, ignore_missing=True):
"""Delete a role
:param role: The value can be either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the role does not exist.
When set to ``True``, no exception will be thrown when
attempting to delete a nonexistent role.
:returns: ``None``
"""
self._delete(_role.Role, role, ignore_missing=ignore_missing)
def find_role(self, name_or_id, ignore_missing=True, **query):
"""Find a single role
:param name_or_id: The name or ID of a role.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the role does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent role.
:returns: One :class:`~openstack.identity.v3.role.Role` or None
"""
return self._find(
_role.Role,
name_or_id,
ignore_missing=ignore_missing,
**query,
)
def get_role(self, role):
"""Get a single role
:param role: The value can be the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:returns: One :class:`~openstack.identity.v3.role.Role`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no matching role can be found.
"""
return self._get(_role.Role, role)
def roles(self, **query):
"""Retrieve a generator of roles
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. The options
are: domain_id, name.
:return: A generator of role instances.
:rtype: :class:`~openstack.identity.v3.role.Role`
"""
return self._list(_role.Role, **query)
def update_role(self, role, **attrs):
"""Update a role
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param dict kwargs: The attributes to update on the role represented
by ``value``. Only name can be updated
:returns: The updated role.
:rtype: :class:`~openstack.identity.v3.role.Role`
"""
return self._update(_role.Role, role, **attrs)
# ========== Role assignments ==========
def role_assignments_filter(
self, domain=None, project=None, system=None, group=None, user=None
):
"""Retrieve a generator of roles assigned to user/group
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param system: Either the system name or a
:class:`~openstack.identity.v3.system.System`
instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:return: A generator of role instances.
:rtype: :class:`~openstack.identity.v3.role.Role`
"""
if domain and project and system:
raise exception.InvalidRequest(
'Only one of domain, project, or system can be specified'
)
if domain is None and project is None and system is None:
raise exception.InvalidRequest(
'Either domain, project, or system should be specified'
)
if group and user:
raise exception.InvalidRequest(
'Only one of group or user can be specified'
)
if group is None and user is None:
raise exception.InvalidRequest(
'Either group or user should be specified'
)
if domain:
domain_id = resource.Resource._get_id(domain)
if group:
group_id = resource.Resource._get_id(group)
return self._list(
_role_domain_group_assignment.RoleDomainGroupAssignment,
domain_id=domain_id,
group_id=group_id,
)
else:
user_id = resource.Resource._get_id(user)
return self._list(
_role_domain_user_assignment.RoleDomainUserAssignment,
domain_id=domain_id,
user_id=user_id,
)
elif project:
project_id = resource.Resource._get_id(project)
if group:
group_id = resource.Resource._get_id(group)
return self._list(
_role_project_group_assignment.RoleProjectGroupAssignment,
project_id=project_id,
group_id=group_id,
)
else:
user_id = resource.Resource._get_id(user)
return self._list(
_role_project_user_assignment.RoleProjectUserAssignment,
project_id=project_id,
user_id=user_id,
)
else:
system_id = resource.Resource._get_id(system)
if group:
group_id = resource.Resource._get_id(group)
return self._list(
_role_system_group_assignment.RoleSystemGroupAssignment,
system_id=system_id,
group_id=group_id,
)
else:
user_id = resource.Resource._get_id(user)
return self._list(
_role_system_user_assignment.RoleSystemUserAssignment,
system_id=system_id,
user_id=user_id,
)
def role_assignments(self, **query):
"""Retrieve a generator of role assignments
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned. The options
are: group_id, role_id, scope_domain_id,
scope_project_id, inherited_to, user_id, include_names,
include_subtree.
:return:
:class:`~openstack.identity.v3.role_assignment.RoleAssignment`
"""
return self._list(_role_assignment.RoleAssignment, **query)
def assign_domain_role_to_user(
self, domain, user, role, *, inherited=False
):
"""Assign role to user on a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
domain = self._get_resource(_domain.Domain, domain)
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
domain.assign_role_to_user(self, user, role, inherited)
def unassign_domain_role_from_user(
self, domain, user, role, *, inherited=False
):
"""Unassign role from user on a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
domain = self._get_resource(_domain.Domain, domain)
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
domain.unassign_role_from_user(self, user, role, inherited)
def validate_user_has_domain_role(
self, domain, user, role, *, inherited=False
):
"""Validates that a user has a role on a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:returns: True if user has role in domain
"""
domain = self._get_resource(_domain.Domain, domain)
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
return domain.validate_user_has_role(self, user, role, inherited)
def assign_domain_role_to_group(
self, domain, group, role, *, inherited=False
):
"""Assign role to group on a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
domain = self._get_resource(_domain.Domain, domain)
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
domain.assign_role_to_group(self, group, role, inherited)
def unassign_domain_role_from_group(
self, domain, group, role, *, inherited=False
):
"""Unassign role from group on a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
domain = self._get_resource(_domain.Domain, domain)
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
domain.unassign_role_from_group(self, group, role, inherited)
def validate_group_has_domain_role(
self, domain, group, role, *, inherited=False
):
"""Validates that a group has a role on a domain
:param domain: Either the ID of a domain or a
:class:`~openstack.identity.v3.domain.Domain` instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:returns: True if group has role on domain
"""
domain = self._get_resource(_domain.Domain, domain)
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
return domain.validate_group_has_role(self, group, role, inherited)
def assign_project_role_to_user(
self, project, user, role, *, inherited=False
):
"""Assign role to user on a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
project = self._get_resource(_project.Project, project)
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
project.assign_role_to_user(self, user, role, inherited)
def unassign_project_role_from_user(
self, project, user, role, *, inherited=False
):
"""Unassign role from user on a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
project = self._get_resource(_project.Project, project)
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
project.unassign_role_from_user(self, user, role, inherited)
def validate_user_has_project_role(
self, project, user, role, *, inherited=False
):
"""Validates that a user has a role on a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:returns: True if user has role in project
"""
project = self._get_resource(_project.Project, project)
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
return project.validate_user_has_role(self, user, role, inherited)
def assign_project_role_to_group(
self, project, group, role, *, inherited=False
):
"""Assign role to group on a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
project = self._get_resource(_project.Project, project)
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
project.assign_role_to_group(self, group, role, inherited)
def unassign_project_role_from_group(
self, project, group, role, *, inherited=False
):
"""Unassign role from group on a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param bool inherited: Whether the role assignment is inherited.
:return: ``None``
"""
project = self._get_resource(_project.Project, project)
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
project.unassign_role_from_group(self, group, role, inherited)
def validate_group_has_project_role(
self, project, group, role, *, inherited=False
):
"""Validates that a group has a role on a project
:param project: Either the ID of a project or a
:class:`~openstack.identity.v3.project.Project`
instance.
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:returns: True if group has role in project
"""
project = self._get_resource(_project.Project, project)
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
return project.validate_group_has_role(self, group, role, inherited)
def assign_system_role_to_user(self, user, role, system):
"""Assign a role to user on a system
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param system: The system name
:return: ``None``
"""
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
system = self._get_resource(_system.System, system)
system.assign_role_to_user(self, user, role)
def unassign_system_role_from_user(self, user, role, system):
"""Unassign a role from user on a system
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param system: The system name
:return: ``None``
"""
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
system = self._get_resource(_system.System, system)
system.unassign_role_from_user(self, user, role)
def validate_user_has_system_role(self, user, role, system):
"""Validates that a user has a role on a system
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param system: The system name
:returns: True if user has role in system
"""
user = self._get_resource(_user.User, user)
role = self._get_resource(_role.Role, role)
system = self._get_resource(_system.System, system)
return system.validate_user_has_role(self, user, role)
def assign_system_role_to_group(self, group, role, system):
"""Assign a role to group on a system
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param system: The system name
:return: ``None``
"""
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
system = self._get_resource(_system.System, system)
system.assign_role_to_group(self, group, role)
def unassign_system_role_from_group(self, group, role, system):
"""Unassign a role from group on a system
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param system: The system name
:return: ``None``
"""
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
system = self._get_resource(_system.System, system)
system.unassign_role_from_group(self, group, role)
def validate_group_has_system_role(self, group, role, system):
"""Validates that a group has a role on a system
:param group: Either the ID of a group or a
:class:`~openstack.identity.v3.group.Group` instance.
:param role: Either the ID of a role or a
:class:`~openstack.identity.v3.role.Role` instance.
:param system: The system name
:returns: True if group has role on system
"""
group = self._get_resource(_group.Group, group)
role = self._get_resource(_role.Role, role)
system = self._get_resource(_system.System, system)
return system.validate_group_has_role(self, group, role)
# ========== Registered limits ==========
def registered_limits(self, **query):
"""Retrieve a generator of registered_limits
:param kwargs query: Optional query parameters to be sent to limit
the registered_limits being returned.
:returns: A generator of registered_limits instances.
:rtype: :class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
"""
return self._list(_registered_limit.RegisteredLimit, **query)
def get_registered_limit(self, registered_limit):
"""Get a single registered_limit
:param registered_limit: The value can be the ID of a registered_limit
or a
:class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
instance.
:returns: One :class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_registered_limit.RegisteredLimit, registered_limit)
def create_registered_limit(self, **attrs):
"""Create a new registered_limit from attributes
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.identity.v3.registered_limit.RegisteredLimit`,
comprised of the properties on the RegisteredLimit class.
:returns: The results of registered_limit creation.
:rtype: :class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
"""
return self._create(_registered_limit.RegisteredLimit, **attrs)
def update_registered_limit(self, registered_limit, **attrs):
"""Update a registered_limit
:param registered_limit: Either the ID of a registered_limit. or a
:class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
instance.
:param dict kwargs: The attributes to update on the registered_limit
represented by ``value``.
:returns: The updated registered_limit.
:rtype:
:class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
"""
return self._update(
_registered_limit.RegisteredLimit, registered_limit, **attrs
)
def delete_registered_limit(self, registered_limit, ignore_missing=True):
"""Delete a registered_limit
:param registered_limit: The value can be either the ID of a
registered_limit or a
:class:`~openstack.identity.v3.registered_limit.RegisteredLimit`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the registered_limit does not exist. When set to ``True``, no
exception will be thrown when attempting to delete a nonexistent
registered_limit.
:returns: ``None``
"""
self._delete(
_registered_limit.RegisteredLimit,
registered_limit,
ignore_missing=ignore_missing,
)
# ========== Limits ==========
def limits(self, **query):
"""Retrieve a generator of limits
:param kwargs query: Optional query parameters to be sent to limit
the limits being returned.
:returns: A generator of limits instances.
:rtype: :class:`~openstack.identity.v3.limit.Limit`
"""
return self._list(_limit.Limit, **query)
def get_limit(self, limit):
"""Get a single limit
:param limit: The value can be the ID of a limit
or a :class:`~openstack.identity.v3.limit.Limit` instance.
:returns: One :class:`~openstack.identity.v3.limit.Limit`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
return self._get(_limit.Limit, limit)
def create_limit(self, **attrs):
"""Create a new limit from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.limit.Limit`, comprised of the
properties on the Limit class.
:returns: The results of limit creation.
:rtype: :class:`~openstack.identity.v3.limit.Limit`
"""
return self._create(_limit.Limit, **attrs)
def update_limit(self, limit, **attrs):
"""Update a limit
:param limit: Either the ID of a limit. or a
:class:`~openstack.identity.v3.limit.Limit` instance.
:param dict kwargs: The attributes to update on the limit represented
by ``value``.
:returns: The updated limit.
:rtype: :class:`~openstack.identity.v3.limit.Limit`
"""
return self._update(_limit.Limit, limit, **attrs)
def delete_limit(self, limit, ignore_missing=True):
"""Delete a limit
:param limit: The value can be either the ID of a limit or a
:class:`~openstack.identity.v3.limit.Limit` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the limit does not exist. When set to ``True``, no exception will
be thrown when attempting to delete a nonexistent limit.
:returns: ``None``
"""
self._delete(_limit.Limit, limit, ignore_missing=ignore_missing)
# ========== Application credentials ==========
def application_credentials(self, user, **query):
"""Retrieve a generator of application credentials
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param kwargs query: Optional query parameters to be sent to
limit the resources being returned.
:returns: A generator of application credentials instances.
:rtype:
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`
"""
user = self._get_resource(_user.User, user)
return self._list(
_application_credential.ApplicationCredential,
user_id=user.id,
**query,
)
def get_application_credential(self, user, application_credential):
"""Get a single application credential
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param application_credential: The value can be the ID of a
application credential or a
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`
instance.
:returns: One
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
user = self._get_resource(_user.User, user)
return self._get(
_application_credential.ApplicationCredential,
application_credential,
user_id=user.id,
)
def create_application_credential(self, user, name, **attrs):
"""Create a new application credential from attributes
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param name: The name of the application credential which is
unique to the user.
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`,
comprised of the properties on the ApplicationCredential class.
:returns: The results of application credential creation.
:rtype:
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`
"""
user = self._get_resource(_user.User, user)
return self._create(
_application_credential.ApplicationCredential,
name=name,
user_id=user.id,
**attrs,
)
def find_application_credential(
self,
user,
name_or_id,
ignore_missing=True,
**query,
):
"""Find a single application credential
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param name_or_id: The name or ID of an application credential.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`
or None
"""
user = self._get_resource(_user.User, user)
return self._find(
_application_credential.ApplicationCredential,
user_id=user.id,
name_or_id=name_or_id,
ignore_missing=ignore_missing,
**query,
)
def delete_application_credential(
self, user, application_credential, ignore_missing=True
):
"""Delete an application credential
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param application credential: The value can be either the ID of an
application credential or a
:class:`~openstack.identity.v3.application_credential.ApplicationCredential`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised
when the application credential does not exist. When set to
``True``, no exception will be thrown when attempting to delete
a nonexistent application credential.
:returns: ``None``
"""
user = self._get_resource(_user.User, user)
self._delete(
_application_credential.ApplicationCredential,
application_credential,
user_id=user.id,
ignore_missing=ignore_missing,
)
# ========== Federation protocols ==========
def create_federation_protocol(self, idp_id, **attrs):
"""Create a new federation protocol from attributes
:param idp_id: The ID of the identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
representing the identity provider the protocol is to be
attached to.
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`,
comprised of the properties on the
FederationProtocol class.
:returns: The results of federation protocol creation
:rtype:
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
"""
idp_cls = _identity_provider.IdentityProvider
if isinstance(idp_id, idp_cls):
idp_id = idp_id.id
return self._create(
_federation_protocol.FederationProtocol, idp_id=idp_id, **attrs
)
def delete_federation_protocol(
self, idp_id, protocol, ignore_missing=True
):
"""Delete a federation protocol
:param idp_id: The ID of the identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
representing the identity provider the protocol is attached to.
Can be None if protocol is a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
instance.
:param protocol: The ID of a federation protocol or a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised
when the federation protocol does not exist. When set to
``True``, no exception will be set when attempting to delete a
nonexistent federation protocol.
:returns: ``None``
"""
cls = _federation_protocol.FederationProtocol
if idp_id is None and isinstance(protocol, cls):
idp_id = protocol.idp_id
idp_cls = _identity_provider.IdentityProvider
if isinstance(idp_id, idp_cls):
idp_id = idp_id.id
self._delete(
cls, protocol, ignore_missing=ignore_missing, idp_id=idp_id
)
def find_federation_protocol(self, idp_id, protocol, ignore_missing=True):
"""Find a single federation protocol
:param idp_id: The ID of the identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
representing the identity provider the protocol is attached to.
:param protocol: The name or ID of a federation protocol.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised
when the resource does not exist. When set to ``True``, None will
be returned when attempting to find a nonexistent resource.
:returns: One federation protocol or None
:rtype:
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
"""
idp_cls = _identity_provider.IdentityProvider
if isinstance(idp_id, idp_cls):
idp_id = idp_id.id
return self._find(
_federation_protocol.FederationProtocol,
protocol,
ignore_missing=ignore_missing,
idp_id=idp_id,
)
def get_federation_protocol(self, idp_id, protocol):
"""Get a single federation protocol
:param idp_id: The ID of the identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
representing the identity provider the protocol is attached to.
Can be None if protocol is a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
:param protocol: The value can be the ID of a federation protocol or a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
instance.
:returns: One federation protocol
:rtype:
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
cls = _federation_protocol.FederationProtocol
if idp_id is None and isinstance(protocol, cls):
idp_id = protocol.idp_id
idp_cls = _identity_provider.IdentityProvider
if isinstance(idp_id, idp_cls):
idp_id = idp_id.id
return self._get(cls, protocol, idp_id=idp_id)
def federation_protocols(self, idp_id, **query):
"""Retrieve a generator of federation protocols
:param idp_id: The ID of the identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
representing the identity provider the protocol is attached to.
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of federation protocol instances.
:rtype:
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
"""
idp_cls = _identity_provider.IdentityProvider
if isinstance(idp_id, idp_cls):
idp_id = idp_id.id
return self._list(
_federation_protocol.FederationProtocol, idp_id=idp_id, **query
)
def update_federation_protocol(self, idp_id, protocol, **attrs):
"""Update a federation protocol
:param idp_id: The ID of the identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
representing the identity provider the protocol is attached to.
Can be None if protocol is a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
:param protocol: Either the ID of a federation protocol or a
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
instance.
:param attrs: The attributes to update on the federation protocol
represented by ``protocol``.
:returns: The updated federation protocol
:rtype:
:class:`~openstack.identity.v3.federation_protocol.FederationProtocol`
"""
cls = _federation_protocol.FederationProtocol
if (idp_id is None) and (isinstance(protocol, cls)):
idp_id = protocol.idp_id
idp_cls = _identity_provider.IdentityProvider
if isinstance(idp_id, idp_cls):
idp_id = idp_id.id
return self._update(cls, protocol, idp_id=idp_id, **attrs)
# ========== Mappings ==========
def create_mapping(self, **attrs):
"""Create a new mapping from attributes
:param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.identity.v3.mapping.Mapping`,
comprised of the properties on the Mapping class.
:returns: The results of mapping creation
:rtype: :class:`~openstack.identity.v3.mapping.Mapping`
"""
return self._create(_mapping.Mapping, **attrs)
def delete_mapping(self, mapping, ignore_missing=True):
"""Delete a mapping
:param mapping: The ID of a mapping or a
:class:`~openstack.identity.v3.mapping.Mapping`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the mapping does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent mapping.
:returns: ``None``
"""
self._delete(_mapping.Mapping, mapping, ignore_missing=ignore_missing)
def find_mapping(self, name_or_id, ignore_missing=True):
"""Find a single mapping
:param name_or_id: The name or ID of a mapping.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: One :class:`~openstack.identity.v3.mapping.Mapping` or None
"""
return self._find(
_mapping.Mapping, name_or_id, ignore_missing=ignore_missing
)
def get_mapping(self, mapping):
"""Get a single mapping
:param mapping: The value can be the ID of a mapping or a
:class:`~openstack.identity.v3.mapping.Mapping`
instance.
:returns: One :class:`~openstack.identity.v3.mapping.Mapping`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_mapping.Mapping, mapping)
def mappings(self, **query):
"""Retrieve a generator of mappings
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of mapping instances.
:rtype: :class:`~openstack.identity.v3.mapping.Mapping`
"""
return self._list(_mapping.Mapping, **query)
def update_mapping(self, mapping, **attrs):
"""Update a mapping
:param mapping: Either the ID of a mapping or a
:class:`~openstack.identity.v3.mapping.Mapping` instance.
:param attrs: The attributes to update on the mapping represented
by ``mapping``.
:returns: The updated mapping
:rtype: :class:`~openstack.identity.v3.mapping.Mapping`
"""
return self._update(_mapping.Mapping, mapping, **attrs)
# ========== Identity providers ==========
def create_identity_provider(self, **attrs):
"""Create a new identity provider from attributes
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
comprised of the properties on the IdentityProvider class.
:returns: The results of identity provider creation
:rtype:
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
"""
return self._create(_identity_provider.IdentityProvider, **attrs)
def delete_identity_provider(self, identity_provider, ignore_missing=True):
"""Delete an identity provider
:param mapping: The ID of an identity provoder or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the identity provider does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent identity provider.
:returns: ``None``
"""
self._delete(
_identity_provider.IdentityProvider,
identity_provider,
ignore_missing=ignore_missing,
)
def find_identity_provider(self, name_or_id, ignore_missing=True):
"""Find a single identity provider
:param name_or_id: The name or ID of an identity provider
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the resource does not exist.
When set to ``True``, None will be returned when
attempting to find a nonexistent resource.
:returns: The details of an identity provider or None.
:rtype:
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
"""
return self._find(
_identity_provider.IdentityProvider,
name_or_id,
ignore_missing=ignore_missing,
)
def get_identity_provider(self, identity_provider):
"""Get a single mapping
:param mapping: The value can be the ID of an identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
instance.
:returns: The details of an identity provider.
:rtype:
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(
_identity_provider.IdentityProvider, identity_provider
)
def identity_providers(self, **query):
"""Retrieve a generator of identity providers
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of identity provider instances.
:rtype:
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
"""
return self._list(_identity_provider.IdentityProvider, **query)
def update_identity_provider(self, identity_provider, **attrs):
"""Update a mapping
:param mapping: Either the ID of an identity provider or a
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
instance.
:param attrs: The attributes to update on the identity_provider
represented by ``identity_provider``.
:returns: The updated identity provider.
:rtype:
:class:`~openstack.identity.v3.identity_provider.IdentityProvider`
"""
return self._update(
_identity_provider.IdentityProvider, identity_provider, **attrs
)
# ========== Access rules ==========
def access_rules(self, user, **query):
"""Retrieve a generator of access rules
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param kwargs query: Optional query parameters to be sent to
limit the resources being returned.
:returns: A generator of access rules instances.
:rtype: :class:`~openstack.identity.v3.access_rule.AccessRule`
"""
user = self._get_resource(_user.User, user)
return self._list(_access_rule.AccessRule, user_id=user.id, **query)
def get_access_rule(self, user, access_rule):
"""Get a single access rule
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param access rule: The value can be the ID of an access rule or a
:class:`~.access_rule.AccessRule` instance.
:returns: One :class:`~.access_rule.AccessRule`
:raises: :class:`~openstack.exceptions.NotFoundException` when no
resource can be found.
"""
user = self._get_resource(_user.User, user)
return self._get(_access_rule.AccessRule, access_rule, user_id=user.id)
def delete_access_rule(self, user, access_rule, ignore_missing=True):
"""Delete an access rule
:param user: Either the ID of a user or a
:class:`~openstack.identity.v3.user.User` instance.
:param access rule: The value can be either the ID of an
access rule or a :class:`~.access_rule.AccessRule` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the access rule does not exist. When set to ``True``, no exception
will be thrown when attempting to delete a nonexistent access rule.
:returns: ``None``
"""
user = self._get_resource(_user.User, user)
self._delete(
_access_rule.AccessRule,
access_rule,
user_id=user.id,
ignore_missing=ignore_missing,
)
# ========== Service providers ==========
def create_service_provider(self, **attrs):
"""Create a new service provider from attributes
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.identity.v3.service_provider.ServiceProvider`,
comprised of the properties on the ServiceProvider class.
:returns: The results of service provider creation
:rtype:
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
"""
return self._create(_service_provider.ServiceProvider, **attrs)
def delete_service_provider(self, service_provider, ignore_missing=True):
"""Delete a service provider
:param service_provider: The ID of a service provider or a
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the service provider does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent service provider.
:returns: ``None``
"""
self._delete(
_service_provider.ServiceProvider,
service_provider,
ignore_missing=ignore_missing,
)
def find_service_provider(self, name_or_id, ignore_missing=True):
"""Find a single service provider
:param name_or_id: The name or ID of a service provider
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be raised when
the resource does not exist. When set to ``True``, None will be
returned when attempting to find a nonexistent resource.
:returns: The details of an service provider or None.
:rtype:
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
"""
return self._find(
_service_provider.ServiceProvider,
name_or_id,
ignore_missing=ignore_missing,
)
def get_service_provider(self, service_provider):
"""Get a single service provider
:param service_provider: The value can be the ID of a service provider
or a
:class:`~openstack.identity.v3.server_provider.ServiceProvider`
instance.
:returns: The details of an service provider.
:rtype:
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_service_provider.ServiceProvider, service_provider)
def service_providers(self, **query):
"""Retrieve a generator of service providers
:param kwargs query: Optional query parameters to be sent to limit
the resources being returned.
:returns: A generator of service provider instances.
:rtype:
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
"""
return self._list(_service_provider.ServiceProvider, **query)
def update_service_provider(self, service_provider, **attrs):
"""Update a service provider
:param service_provider: Either the ID of an service provider or a
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
instance.
:param attrs: The attributes to update on the service provider
represented by ``service_provider``.
:returns: The updated service provider.
:rtype:
:class:`~openstack.identity.v3.service_provider.ServiceProvider`
"""
return self._update(
_service_provider.ServiceProvider, service_provider, **attrs
)
# ========== Utilities ==========
def wait_for_status(
self,
res: resource.ResourceT,
status: str,
failures: list[str] | None = None,
interval: int | float | None = 2,
wait: int | None = None,
attribute: str = 'status',
callback: ty.Callable[[int], None] | None = None,
) -> resource.ResourceT:
"""Wait for the resource to be in a particular status.
:param session: The session to use for making this request.
:param resource: The resource to wait on to reach the status. The
resource must have a status attribute specified via ``attribute``.
:param status: Desired status of the resource.
:param failures: Statuses that would indicate the transition
failed such as 'ERROR'. Defaults to ['ERROR'].
:param interval: Number of seconds to wait between checks.
:param wait: Maximum number of seconds to wait for transition.
Set to ``None`` to wait forever.
:param attribute: Name of the resource attribute that contains the
status.
:param callback: A callback function. This will be called with a single
value, progress. This is API specific but is generally a percentage
value from 0-100.
:return: The updated resource.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if the
transition to status failed to occur in ``wait`` seconds.
:raises: :class:`~openstack.exceptions.ResourceFailure` if the resource
transitioned to one of the states in ``failures``.
:raises: :class:`~AttributeError` if the resource does not have a
``status`` attribute
"""
return resource.wait_for_status(
self, res, status, failures, interval, wait, attribute, callback
)
def wait_for_delete(
self,
res: resource.ResourceT,
interval: int = 2,
wait: int = 120,
callback: ty.Callable[[int], None] | None = None,
) -> resource.ResourceT:
"""Wait for a resource to be deleted.
:param res: The resource to wait on to be deleted.
:param interval: Number of seconds to wait before to consecutive
checks.
:param wait: Maximum number of seconds to wait before the change.
:param callback: A callback function. This will be called with a single
value, progress, which is a percentage value from 0-100.
:returns: The resource is returned on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if transition
to delete failed to occur in the specified seconds.
"""
return resource.wait_for_delete(self, res, interval, wait, callback)
|