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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Contains information about an action for a request for which an authorization
// decision is made.
//
// This data type is used as a request parameter to the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations.
//
// Example: { "actionId": "<action name>", "actionType": "Action" }
//
// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html
// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
type ActionIdentifier struct {
// The ID of an action.
//
// This member is required.
ActionId *string
// The type of an action.
//
// This member is required.
ActionType *string
noSmithyDocumentSerde
}
// The value of an attribute.
//
// Contains information about the runtime context for a request for which an
// authorization decision is made.
//
// This data type is used as a member of the [ContextDefinition] structure which is uses as a request
// parameter for the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations.
//
// The following types satisfy this interface:
//
// AttributeValueMemberBoolean
// AttributeValueMemberEntityIdentifier
// AttributeValueMemberLong
// AttributeValueMemberRecord
// AttributeValueMemberSet
// AttributeValueMemberString
//
// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html
// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
// [ContextDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html
type AttributeValue interface {
isAttributeValue()
}
// An attribute value of [Boolean] type.
//
// Example: {"boolean": true}
//
// [Boolean]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#boolean
type AttributeValueMemberBoolean struct {
Value bool
noSmithyDocumentSerde
}
func (*AttributeValueMemberBoolean) isAttributeValue() {}
// An attribute value of type [EntityIdentifier].
//
// Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity
// type>"}
//
// [EntityIdentifier]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html
type AttributeValueMemberEntityIdentifier struct {
Value EntityIdentifier
noSmithyDocumentSerde
}
func (*AttributeValueMemberEntityIdentifier) isAttributeValue() {}
// An attribute value of [Long] type.
//
// Example: {"long": 0}
//
// [Long]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#long
type AttributeValueMemberLong struct {
Value int64
noSmithyDocumentSerde
}
func (*AttributeValueMemberLong) isAttributeValue() {}
// An attribute value of [Record] type.
//
// Example: {"record": { "keyName": {} } }
//
// [Record]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record
type AttributeValueMemberRecord struct {
Value map[string]AttributeValue
noSmithyDocumentSerde
}
func (*AttributeValueMemberRecord) isAttributeValue() {}
// An attribute value of [Set] type.
//
// Example: {"set": [ {} ] }
//
// [Set]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#set
type AttributeValueMemberSet struct {
Value []AttributeValue
noSmithyDocumentSerde
}
func (*AttributeValueMemberSet) isAttributeValue() {}
// An attribute value of [String] type.
//
// Example: {"string": "abc"}
//
// [String]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#string
type AttributeValueMemberString struct {
Value string
noSmithyDocumentSerde
}
func (*AttributeValueMemberString) isAttributeValue() {}
// An authorization request that you include in a BatchIsAuthorized API request.
type BatchIsAuthorizedInputItem struct {
// Specifies the requested action to be authorized. For example,
// PhotoFlash::ReadPhoto .
Action *ActionIdentifier
// Specifies additional context that can be used to make more granular
// authorization decisions.
Context ContextDefinition
// Specifies the principal for which the authorization decision is to be made.
Principal *EntityIdentifier
// Specifies the resource that you want an authorization decision for. For
// example, PhotoFlash::Photo .
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// The decision, based on policy evaluation, from an individual authorization
// request in a BatchIsAuthorized API request.
type BatchIsAuthorizedOutputItem struct {
// An authorization decision that indicates if the authorization request should be
// allowed or denied.
//
// This member is required.
Decision Decision
// The list of determining policies used to make the authorization decision. For
// example, if there are two matching policies, where one is a forbid and the other
// is a permit, then the forbid policy will be the determining policy. In the case
// of multiple matching permit policies then there would be multiple determining
// policies. In the case that no policies match, and hence the response is DENY,
// there would be no determining policies.
//
// This member is required.
DeterminingPolicies []DeterminingPolicyItem
// Errors that occurred while making an authorization decision. For example, a
// policy might reference an entity or attribute that doesn't exist in the request.
//
// This member is required.
Errors []EvaluationErrorItem
// The authorization request that initiated the decision.
//
// This member is required.
Request *BatchIsAuthorizedInputItem
noSmithyDocumentSerde
}
// An authorization request that you include in a BatchIsAuthorizedWithToken API
// request.
type BatchIsAuthorizedWithTokenInputItem struct {
// Specifies the requested action to be authorized. For example,
// PhotoFlash::ReadPhoto .
Action *ActionIdentifier
// Specifies additional context that can be used to make more granular
// authorization decisions.
Context ContextDefinition
// Specifies the resource that you want an authorization decision for. For
// example, PhotoFlash::Photo .
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// The decision, based on policy evaluation, from an individual authorization
// request in a BatchIsAuthorizedWithToken API request.
type BatchIsAuthorizedWithTokenOutputItem struct {
// An authorization decision that indicates if the authorization request should be
// allowed or denied.
//
// This member is required.
Decision Decision
// The list of determining policies used to make the authorization decision. For
// example, if there are two matching policies, where one is a forbid and the other
// is a permit, then the forbid policy will be the determining policy. In the case
// of multiple matching permit policies then there would be multiple determining
// policies. In the case that no policies match, and hence the response is DENY,
// there would be no determining policies.
//
// This member is required.
DeterminingPolicies []DeterminingPolicyItem
// Errors that occurred while making an authorization decision. For example, a
// policy might reference an entity or attribute that doesn't exist in the request.
//
// This member is required.
Errors []EvaluationErrorItem
// The authorization request that initiated the decision.
//
// This member is required.
Request *BatchIsAuthorizedWithTokenInputItem
noSmithyDocumentSerde
}
// The type of entity that a policy store maps to groups from an Amazon Cognito
// user pool identity source.
//
// This data type is part of a [CognitoUserPoolConfiguration] structure and is a request parameter in [CreateIdentitySource].
//
// [CognitoUserPoolConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfiguration.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type CognitoGroupConfiguration struct {
// The name of the schema entity type that's mapped to the user pool group.
// Defaults to AWS::CognitoGroup .
//
// This member is required.
GroupEntityType *string
noSmithyDocumentSerde
}
// The type of entity that a policy store maps to groups from an Amazon Cognito
// user pool identity source.
//
// This data type is part of an [CognitoUserPoolConfigurationDetail] structure and is a response parameter to [GetIdentitySource].
//
// [CognitoUserPoolConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationItem.html
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
type CognitoGroupConfigurationDetail struct {
// The name of the schema entity type that's mapped to the user pool group.
// Defaults to AWS::CognitoGroup .
GroupEntityType *string
noSmithyDocumentSerde
}
// The type of entity that a policy store maps to groups from an Amazon Cognito
// user pool identity source.
//
// This data type is part of an [CognitoUserPoolConfigurationItem] structure and is a response parameter to [ListIdentitySources].
//
// [CognitoUserPoolConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationDetail.html
// [ListIdentitySources]: http://forums.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type CognitoGroupConfigurationItem struct {
// The name of the schema entity type that's mapped to the user pool group.
// Defaults to AWS::CognitoGroup .
GroupEntityType *string
noSmithyDocumentSerde
}
// The configuration for an identity source that represents a connection to an
// Amazon Cognito user pool used as an identity provider for Verified Permissions.
//
// This data type part of a [Configuration] structure that is used as a parameter to [CreateIdentitySource].
//
// Example:
// "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType":
// "MyCorp::Group"}}
//
// [Configuration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type CognitoUserPoolConfiguration struct {
// The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be
// authorized.
//
// Example: "UserPoolArn":
// "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
UserPoolArn *string
// The unique application client IDs that are associated with the specified Amazon
// Cognito user pool.
//
// Example: "ClientIds": ["&ExampleCogClientId;"]
ClientIds []string
// The type of entity that a policy store maps to groups from an Amazon Cognito
// user pool identity source.
GroupConfiguration *CognitoGroupConfiguration
noSmithyDocumentSerde
}
// The configuration for an identity source that represents a connection to an
// Amazon Cognito user pool used as an identity provider for Verified Permissions.
//
// This data type is used as a field that is part of an [ConfigurationDetail] structure that is part of
// the response to [GetIdentitySource].
//
// Example:
// "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType":
// "MyCorp::Group"}}
//
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
// [ConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html
type CognitoUserPoolConfigurationDetail struct {
// The unique application client IDs that are associated with the specified Amazon
// Cognito user pool.
//
// Example: "clientIds": ["&ExampleCogClientId;"]
//
// This member is required.
ClientIds []string
// The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that
// contains the identities to be authorized.
//
// Example: "issuer":
// "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"
//
// This member is required.
Issuer *string
// The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be
// authorized.
//
// Example: "userPoolArn":
// "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
UserPoolArn *string
// The type of entity that a policy store maps to groups from an Amazon Cognito
// user pool identity source.
GroupConfiguration *CognitoGroupConfigurationDetail
noSmithyDocumentSerde
}
// The configuration for an identity source that represents a connection to an
// Amazon Cognito user pool used as an identity provider for Verified Permissions.
//
// This data type is used as a field that is part of the [ConfigurationItem] structure that is part
// of the response to [ListIdentitySources].
//
// Example:
// "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType":
// "MyCorp::Group"}}
//
// [ConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type CognitoUserPoolConfigurationItem struct {
// The unique application client IDs that are associated with the specified Amazon
// Cognito user pool.
//
// Example: "clientIds": ["&ExampleCogClientId;"]
//
// This member is required.
ClientIds []string
// The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that
// contains the identities to be authorized.
//
// Example: "issuer":
// "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"
//
// This member is required.
Issuer *string
// The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be
// authorized.
//
// Example: "userPoolArn":
// "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
UserPoolArn *string
// The type of entity that a policy store maps to groups from an Amazon Cognito
// user pool identity source.
GroupConfiguration *CognitoGroupConfigurationItem
noSmithyDocumentSerde
}
// Contains configuration information used when creating a new identity source.
//
// This data type is used as a request parameter for the [CreateIdentitySource] operation.
//
// The following types satisfy this interface:
//
// ConfigurationMemberCognitoUserPoolConfiguration
// ConfigurationMemberOpenIdConnectConfiguration
//
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type Configuration interface {
isConfiguration()
}
// Contains configuration details of a Amazon Cognito user pool that Verified
// Permissions can use as a source of authenticated identities as entities. It
// specifies the [Amazon Resource Name (ARN)]of a Amazon Cognito user pool and one or more application client
// IDs.
//
// Example:
// "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType":
// "MyCorp::Group"}}}
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
type ConfigurationMemberCognitoUserPoolConfiguration struct {
Value CognitoUserPoolConfiguration
noSmithyDocumentSerde
}
func (*ConfigurationMemberCognitoUserPoolConfiguration) isConfiguration() {}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// Example:
// "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
type ConfigurationMemberOpenIdConnectConfiguration struct {
Value OpenIdConnectConfiguration
noSmithyDocumentSerde
}
func (*ConfigurationMemberOpenIdConnectConfiguration) isConfiguration() {}
// Contains configuration information about an identity source.
//
// This data type is a response parameter to the [GetIdentitySource] operation.
//
// The following types satisfy this interface:
//
// ConfigurationDetailMemberCognitoUserPoolConfiguration
// ConfigurationDetailMemberOpenIdConnectConfiguration
//
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
type ConfigurationDetail interface {
isConfigurationDetail()
}
// Contains configuration details of a Amazon Cognito user pool that Verified
// Permissions can use as a source of authenticated identities as entities. It
// specifies the [Amazon Resource Name (ARN)]of a Amazon Cognito user pool, the policy store entity that you
// want to assign to user groups, and one or more application client IDs.
//
// Example:
// "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType":
// "MyCorp::Group"}}}
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
type ConfigurationDetailMemberCognitoUserPoolConfiguration struct {
Value CognitoUserPoolConfigurationDetail
noSmithyDocumentSerde
}
func (*ConfigurationDetailMemberCognitoUserPoolConfiguration) isConfigurationDetail() {}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// Example:
// "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
type ConfigurationDetailMemberOpenIdConnectConfiguration struct {
Value OpenIdConnectConfigurationDetail
noSmithyDocumentSerde
}
func (*ConfigurationDetailMemberOpenIdConnectConfiguration) isConfigurationDetail() {}
// Contains configuration information about an identity source.
//
// This data type is a response parameter to the [ListIdentitySources] operation.
//
// The following types satisfy this interface:
//
// ConfigurationItemMemberCognitoUserPoolConfiguration
// ConfigurationItemMemberOpenIdConnectConfiguration
//
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type ConfigurationItem interface {
isConfigurationItem()
}
// Contains configuration details of a Amazon Cognito user pool that Verified
// Permissions can use as a source of authenticated identities as entities. It
// specifies the [Amazon Resource Name (ARN)]of a Amazon Cognito user pool, the policy store entity that you
// want to assign to user groups, and one or more application client IDs.
//
// Example:
// "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
// ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType":
// "MyCorp::Group"}}}
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
type ConfigurationItemMemberCognitoUserPoolConfiguration struct {
Value CognitoUserPoolConfigurationItem
noSmithyDocumentSerde
}
func (*ConfigurationItemMemberCognitoUserPoolConfiguration) isConfigurationItem() {}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// Example:
// "configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}
type ConfigurationItemMemberOpenIdConnectConfiguration struct {
Value OpenIdConnectConfigurationItem
noSmithyDocumentSerde
}
func (*ConfigurationItemMemberOpenIdConnectConfiguration) isConfigurationItem() {}
// Contains additional details about the context of the request. Verified
// Permissions evaluates this information in an authorization request as part of
// the when and unless clauses in a policy.
//
// This data type is used as a request parameter for the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations.
//
// Example:
// "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}
//
// The following types satisfy this interface:
//
// ContextDefinitionMemberContextMap
//
// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html
// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
type ContextDefinition interface {
isContextDefinition()
}
// An list of attributes that are needed to successfully evaluate an authorization
// request. Each attribute in this array must include a map of a data type and its
// value.
//
// Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}
type ContextDefinitionMemberContextMap struct {
Value map[string]AttributeValue
noSmithyDocumentSerde
}
func (*ContextDefinitionMemberContextMap) isContextDefinition() {}
// Contains information about one of the policies that determined an authorization
// decision.
//
// This data type is used as an element in a response parameter for the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken]
// operations.
//
// Example: "determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}]
//
// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html
// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
type DeterminingPolicyItem struct {
// The Id of a policy that determined to an authorization decision.
//
// Example: "policyId":"SPEXAMPLEabcdefg111111"
//
// This member is required.
PolicyId *string
noSmithyDocumentSerde
}
// Contains the list of entities to be considered during an authorization request.
// This includes all principals, resources, and actions required to successfully
// evaluate the request.
//
// This data type is used as a field in the response parameter for the [IsAuthorized] and [IsAuthorizedWithToken]
// operations.
//
// The following types satisfy this interface:
//
// EntitiesDefinitionMemberEntityList
//
// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
type EntitiesDefinition interface {
isEntitiesDefinition()
}
// An array of entities that are needed to successfully evaluate an authorization
// request. Each entity in this array must include an identifier for the entity,
// the attributes of the entity, and a list of any parent entities.
type EntitiesDefinitionMemberEntityList struct {
Value []EntityItem
noSmithyDocumentSerde
}
func (*EntitiesDefinitionMemberEntityList) isEntitiesDefinition() {}
// Contains the identifier of an entity, including its ID and type.
//
// This data type is used as a request parameter for [IsAuthorized] operation, and as a response
// parameter for the [CreatePolicy], [GetPolicy], and [UpdatePolicy] operations.
//
// Example: {"entityId":"string","entityType":"string"}
//
// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html
// [UpdatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
// [GetPolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html
type EntityIdentifier struct {
// The identifier of an entity.
//
// "entityId":"identifier"
//
// This member is required.
EntityId *string
// The type of an entity.
//
// Example: "entityType":"typeName"
//
// This member is required.
EntityType *string
noSmithyDocumentSerde
}
// Contains information about an entity that can be referenced in a Cedar policy.
//
// This data type is used as one of the fields in the [EntitiesDefinition] structure.
//
// { "identifier": { "entityType": "Photo", "entityId": "VacationPhoto94.jpg" },
// "attributes": {}, "parents": [ { "entityType": "Album", "entityId":
// "alice_folder" } ] }
//
// [EntitiesDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html
type EntityItem struct {
// The identifier of the entity.
//
// This member is required.
Identifier *EntityIdentifier
// A list of attributes for the entity.
Attributes map[string]AttributeValue
// The parent entities in the hierarchy that contains the entity. A principal or
// resource entity can be defined with at most 99 transitive parents per
// authorization request.
//
// A transitive parent is an entity in the hierarchy of entities including all
// direct parents, and parents of parents. For example, a user can be a member of
// 91 groups if one of those groups is a member of eight groups, for a total of
// 100: one entity, 91 entity parents, and eight parents of parents.
Parents []EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a principal or resource that can be referenced in a
// Cedar policy.
//
// This data type is used as part of the [PolicyFilter] structure that is used as a request
// parameter for the [ListPolicies]operation..
//
// The following types satisfy this interface:
//
// EntityReferenceMemberIdentifier
// EntityReferenceMemberUnspecified
//
// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html
// [PolicyFilter]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html
type EntityReference interface {
isEntityReference()
}
// The identifier of the entity. It can consist of either an EntityType and
// EntityId, a principal, or a resource.
type EntityReferenceMemberIdentifier struct {
Value EntityIdentifier
noSmithyDocumentSerde
}
func (*EntityReferenceMemberIdentifier) isEntityReference() {}
// Used to indicate that a principal or resource is not specified. This can be
// used to search for policies that are not associated with a specific principal or
// resource.
type EntityReferenceMemberUnspecified struct {
Value bool
noSmithyDocumentSerde
}
func (*EntityReferenceMemberUnspecified) isEntityReference() {}
// Contains a description of an evaluation error.
//
// This data type is a response parameter of the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations.
//
// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html
// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html
// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html
type EvaluationErrorItem struct {
// The error description.
//
// This member is required.
ErrorDescription *string
noSmithyDocumentSerde
}
// A structure that contains configuration of the identity source.
//
// This data type was a response parameter for the [GetIdentitySource] operation. Replaced by [ConfigurationDetail].
//
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
// [ConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html
type IdentitySourceDetails struct {
// The application client IDs associated with the specified Amazon Cognito user
// pool that are enabled for this identity source.
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration.clientIds
ClientIds []string
// The well-known URL that points to this user pool's OIDC discovery endpoint.
// This is a URL string in the following format. This URL replaces the placeholders
// for both the Amazon Web Services Region and the user pool identifier with those
// appropriate for this user pool.
//
// https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration.issuer
DiscoveryUrl *string
// A string that identifies the type of OIDC service represented by this identity
// source.
//
// At this time, the only valid value is cognito .
//
// Deprecated: This attribute has been replaced by configuration
OpenIdIssuer OpenIdIssuer
// The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool whose identities are accessible to this
// Verified Permissions policy store.
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration.userPoolArn
UserPoolArn *string
noSmithyDocumentSerde
}
// A structure that defines characteristics of an identity source that you can use
// to filter.
//
// This data type is a request parameter for the [ListIdentityStores] operation.
//
// [ListIdentityStores]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html
type IdentitySourceFilter struct {
// The Cedar entity type of the principals returned by the identity provider (IdP)
// associated with this identity source.
PrincipalEntityType *string
noSmithyDocumentSerde
}
// A structure that defines an identity source.
//
// This data type is a response parameter to the [ListIdentitySources] operation.
//
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type IdentitySourceItem struct {
// The date and time the identity source was originally created.
//
// This member is required.
CreatedDate *time.Time
// The unique identifier of the identity source.
//
// This member is required.
IdentitySourceId *string
// The date and time the identity source was most recently updated.
//
// This member is required.
LastUpdatedDate *time.Time
// The identifier of the policy store that contains the identity source.
//
// This member is required.
PolicyStoreId *string
// The Cedar entity type of the principals returned from the IdP associated with
// this identity source.
//
// This member is required.
PrincipalEntityType *string
// Contains configuration information about an identity source.
Configuration ConfigurationItem
// A structure that contains the details of the associated identity provider (IdP).
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration
Details *IdentitySourceItemDetails
noSmithyDocumentSerde
}
// A structure that contains configuration of the identity source.
//
// This data type was a response parameter for the [ListIdentitySources] operation. Replaced by [ConfigurationItem].
//
// [ConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type IdentitySourceItemDetails struct {
// The application client IDs associated with the specified Amazon Cognito user
// pool that are enabled for this identity source.
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration.clientIds
ClientIds []string
// The well-known URL that points to this user pool's OIDC discovery endpoint.
// This is a URL string in the following format. This URL replaces the placeholders
// for both the Amazon Web Services Region and the user pool identifier with those
// appropriate for this user pool.
//
// https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration.issuer
DiscoveryUrl *string
// A string that identifies the type of OIDC service represented by this identity
// source.
//
// At this time, the only valid value is cognito .
//
// Deprecated: This attribute has been replaced by configuration
OpenIdIssuer OpenIdIssuer
// The Amazon Cognito user pool whose identities are accessible to this Verified
// Permissions policy store.
//
// Deprecated: This attribute has been replaced by
// configuration.cognitoUserPoolConfiguration.userPoolArn
UserPoolArn *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// access token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [OpenIdConnectTokenSelection] structure, which is a parameter of [CreateIdentitySource].
//
// [OpenIdConnectTokenSelection]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type OpenIdConnectAccessTokenConfiguration struct {
// The access token aud claim values that you want to accept in your policy store.
// For example, https://myapp.example.com, https://myapp2.example.com .
Audiences []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// access token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [OpenIdConnectTokenSelectionDetail] structure, which is a parameter of [GetIdentitySource].
//
// [OpenIdConnectTokenSelectionDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionDetail.html
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
type OpenIdConnectAccessTokenConfigurationDetail struct {
// The access token aud claim values that you want to accept in your policy store.
// For example, https://myapp.example.com, https://myapp2.example.com .
Audiences []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// access token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [OpenIdConnectTokenSelectionItem] structure, which is a parameter of [ListIdentitySources].
//
// [OpenIdConnectTokenSelectionItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionItem.html
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type OpenIdConnectAccessTokenConfigurationItem struct {
// The access token aud claim values that you want to accept in your policy store.
// For example, https://myapp.example.com, https://myapp2.example.com .
Audiences []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// This data type is part of a [Configuration] structure, which is a parameter to [CreateIdentitySource].
//
// [Configuration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type OpenIdConnectConfiguration struct {
// The issuer URL of an OIDC identity provider. This URL must have an OIDC
// discovery endpoint at the path .well-known/openid-configuration .
//
// This member is required.
Issuer *string
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This member is required.
TokenSelection OpenIdConnectTokenSelection
// A descriptive string that you want to prefix to user entities from your OIDC
// identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider ,
// you can reference principals in your policies in the format
// MyCorp::User::MyOIDCProvider|Carlos .
EntityIdPrefix *string
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
GroupConfiguration *OpenIdConnectGroupConfiguration
noSmithyDocumentSerde
}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// This data type is part of a [ConfigurationDetail] structure, which is a parameter to [GetIdentitySource].
//
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
// [ConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html
type OpenIdConnectConfigurationDetail struct {
// The issuer URL of an OIDC identity provider. This URL must have an OIDC
// discovery endpoint at the path .well-known/openid-configuration .
//
// This member is required.
Issuer *string
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This member is required.
TokenSelection OpenIdConnectTokenSelectionDetail
// A descriptive string that you want to prefix to user entities from your OIDC
// identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider ,
// you can reference principals in your policies in the format
// MyCorp::User::MyOIDCProvider|Carlos .
EntityIdPrefix *string
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
GroupConfiguration *OpenIdConnectGroupConfigurationDetail
noSmithyDocumentSerde
}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// This data type is part of a [ConfigurationItem] structure, which is a parameter to [ListIdentitySources].
//
// [ConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type OpenIdConnectConfigurationItem struct {
// The issuer URL of an OIDC identity provider. This URL must have an OIDC
// discovery endpoint at the path .well-known/openid-configuration .
//
// This member is required.
Issuer *string
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This member is required.
TokenSelection OpenIdConnectTokenSelectionItem
// A descriptive string that you want to prefix to user entities from your OIDC
// identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider ,
// you can reference principals in your policies in the format
// MyCorp::User::MyOIDCProvider|Carlos .
EntityIdPrefix *string
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
GroupConfiguration *OpenIdConnectGroupConfigurationItem
noSmithyDocumentSerde
}
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
//
// This data type is part of a [OpenIdConnectConfiguration] structure, which is a parameter of [CreateIdentitySource].
//
// [OpenIdConnectConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type OpenIdConnectGroupConfiguration struct {
// The token claim that you want Verified Permissions to interpret as group
// membership. For example, groups .
//
// This member is required.
GroupClaim *string
// The policy store entity type that you want to map your users' group claim to.
// For example, MyCorp::UserGroup . A group entity type is an entity that can have
// a user entity type as a member.
//
// This member is required.
GroupEntityType *string
noSmithyDocumentSerde
}
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
//
// This data type is part of a [OpenIdConnectConfigurationDetail] structure, which is a parameter of [GetIdentitySource].
//
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
// [OpenIdConnectConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationDetail.html
type OpenIdConnectGroupConfigurationDetail struct {
// The token claim that you want Verified Permissions to interpret as group
// membership. For example, groups .
//
// This member is required.
GroupClaim *string
// The policy store entity type that you want to map your users' group claim to.
// For example, MyCorp::UserGroup . A group entity type is an entity that can have
// a user entity type as a member.
//
// This member is required.
GroupEntityType *string
noSmithyDocumentSerde
}
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
//
// This data type is part of a [OpenIdConnectConfigurationItem] structure, which is a parameter of [ListIdentitySourcea].
//
// [ListIdentitySourcea]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
// [OpenIdConnectConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationItem.html
type OpenIdConnectGroupConfigurationItem struct {
// The token claim that you want Verified Permissions to interpret as group
// membership. For example, groups .
//
// This member is required.
GroupClaim *string
// The policy store entity type that you want to map your users' group claim to.
// For example, MyCorp::UserGroup . A group entity type is an entity that can have
// a user entity type as a member.
//
// This member is required.
GroupEntityType *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// identity (ID) token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [OpenIdConnectTokenSelection] structure, which is a parameter of [CreateIdentitySource].
//
// [OpenIdConnectTokenSelection]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type OpenIdConnectIdentityTokenConfiguration struct {
// The ID token audience, or client ID, claim values that you want to accept in
// your policy store from an OIDC identity provider. For example,
// 1example23456789, 2example10111213 .
ClientIds []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// identity (ID) token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [OpenIdConnectTokenSelectionDetail] structure, which is a parameter of [GetIdentitySource].
//
// [OpenIdConnectTokenSelectionDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionDetail.html
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
type OpenIdConnectIdentityTokenConfigurationDetail struct {
// The ID token audience, or client ID, claim values that you want to accept in
// your policy store from an OIDC identity provider. For example,
// 1example23456789, 2example10111213 .
ClientIds []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// identity (ID) token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [OpenIdConnectTokenSelectionItem] structure, which is a parameter of [ListIdentitySources].
//
// [OpenIdConnectTokenSelectionItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionItem.html
// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type OpenIdConnectIdentityTokenConfigurationItem struct {
// The ID token audience, or client ID, claim values that you want to accept in
// your policy store from an OIDC identity provider. For example,
// 1example23456789, 2example10111213 .
ClientIds []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This data type is part of a [OpenIdConnectConfiguration] structure, which is a parameter of [CreateIdentitySource].
//
// The following types satisfy this interface:
//
// OpenIdConnectTokenSelectionMemberAccessTokenOnly
// OpenIdConnectTokenSelectionMemberIdentityTokenOnly
//
// [OpenIdConnectConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html
// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html
type OpenIdConnectTokenSelection interface {
isOpenIdConnectTokenSelection()
}
// The OIDC configuration for processing access tokens. Contains allowed audience
// claims, for example https://auth.example.com , and the claim that you want to
// map to the principal, for example sub .
type OpenIdConnectTokenSelectionMemberAccessTokenOnly struct {
Value OpenIdConnectAccessTokenConfiguration
noSmithyDocumentSerde
}
func (*OpenIdConnectTokenSelectionMemberAccessTokenOnly) isOpenIdConnectTokenSelection() {}
// The OIDC configuration for processing identity (ID) tokens. Contains allowed
// client ID claims, for example 1example23456789 , and the claim that you want to
// map to the principal, for example sub .
type OpenIdConnectTokenSelectionMemberIdentityTokenOnly struct {
Value OpenIdConnectIdentityTokenConfiguration
noSmithyDocumentSerde
}
func (*OpenIdConnectTokenSelectionMemberIdentityTokenOnly) isOpenIdConnectTokenSelection() {}
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This data type is part of a [OpenIdConnectConfigurationDetail] structure, which is a parameter of [GetIdentitySource].
//
// The following types satisfy this interface:
//
// OpenIdConnectTokenSelectionDetailMemberAccessTokenOnly
// OpenIdConnectTokenSelectionDetailMemberIdentityTokenOnly
//
// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html
// [OpenIdConnectConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationDetail.html
type OpenIdConnectTokenSelectionDetail interface {
isOpenIdConnectTokenSelectionDetail()
}
// The OIDC configuration for processing access tokens. Contains allowed audience
// claims, for example https://auth.example.com , and the claim that you want to
// map to the principal, for example sub .
type OpenIdConnectTokenSelectionDetailMemberAccessTokenOnly struct {
Value OpenIdConnectAccessTokenConfigurationDetail
noSmithyDocumentSerde
}
func (*OpenIdConnectTokenSelectionDetailMemberAccessTokenOnly) isOpenIdConnectTokenSelectionDetail() {
}
// The OIDC configuration for processing identity (ID) tokens. Contains allowed
// client ID claims, for example 1example23456789 , and the claim that you want to
// map to the principal, for example sub .
type OpenIdConnectTokenSelectionDetailMemberIdentityTokenOnly struct {
Value OpenIdConnectIdentityTokenConfigurationDetail
noSmithyDocumentSerde
}
func (*OpenIdConnectTokenSelectionDetailMemberIdentityTokenOnly) isOpenIdConnectTokenSelectionDetail() {
}
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This data type is part of a [OpenIdConnectConfigurationItem] structure, which is a parameter of [ListIdentitySources].
//
// The following types satisfy this interface:
//
// OpenIdConnectTokenSelectionItemMemberAccessTokenOnly
// OpenIdConnectTokenSelectionItemMemberIdentityTokenOnly
//
// [OpenIdConnectConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationItem.html
// [ListIdentitySources]: http://amazonaws.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html
type OpenIdConnectTokenSelectionItem interface {
isOpenIdConnectTokenSelectionItem()
}
// The OIDC configuration for processing access tokens. Contains allowed audience
// claims, for example https://auth.example.com , and the claim that you want to
// map to the principal, for example sub .
type OpenIdConnectTokenSelectionItemMemberAccessTokenOnly struct {
Value OpenIdConnectAccessTokenConfigurationItem
noSmithyDocumentSerde
}
func (*OpenIdConnectTokenSelectionItemMemberAccessTokenOnly) isOpenIdConnectTokenSelectionItem() {}
// The OIDC configuration for processing identity (ID) tokens. Contains allowed
// client ID claims, for example 1example23456789 , and the claim that you want to
// map to the principal, for example sub .
type OpenIdConnectTokenSelectionItemMemberIdentityTokenOnly struct {
Value OpenIdConnectIdentityTokenConfigurationItem
noSmithyDocumentSerde
}
func (*OpenIdConnectTokenSelectionItemMemberIdentityTokenOnly) isOpenIdConnectTokenSelectionItem() {}
// A structure that contains the details for a Cedar policy definition. It
// includes the policy type, a description, and a policy body. This is a top level
// data type used to create a policy.
//
// This data type is used as a request parameter for the [CreatePolicy] operation. This
// structure must always have either an static or a templateLinked element.
//
// The following types satisfy this interface:
//
// PolicyDefinitionMemberStatic
// PolicyDefinitionMemberTemplateLinked
//
// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html
type PolicyDefinition interface {
isPolicyDefinition()
}
// A structure that describes a static policy. An static policy doesn't use a
// template or allow placeholders for entities.
type PolicyDefinitionMemberStatic struct {
Value StaticPolicyDefinition
noSmithyDocumentSerde
}
func (*PolicyDefinitionMemberStatic) isPolicyDefinition() {}
// A structure that describes a policy that was instantiated from a template. The
// template can specify placeholders for principal and resource . When you use [CreatePolicy] to
// create a policy from a template, you specify the exact principal and resource to
// use for the instantiated policy.
//
// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html
type PolicyDefinitionMemberTemplateLinked struct {
Value TemplateLinkedPolicyDefinition
noSmithyDocumentSerde
}
func (*PolicyDefinitionMemberTemplateLinked) isPolicyDefinition() {}
// A structure that describes a policy definition. It must always have either an
// static or a templateLinked element.
//
// This data type is used as a response parameter for the [GetPolicy] operation.
//
// The following types satisfy this interface:
//
// PolicyDefinitionDetailMemberStatic
// PolicyDefinitionDetailMemberTemplateLinked
//
// [GetPolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html
type PolicyDefinitionDetail interface {
isPolicyDefinitionDetail()
}
// Information about a static policy that wasn't created with a policy template.
type PolicyDefinitionDetailMemberStatic struct {
Value StaticPolicyDefinitionDetail
noSmithyDocumentSerde
}
func (*PolicyDefinitionDetailMemberStatic) isPolicyDefinitionDetail() {}
// Information about a template-linked policy that was created by instantiating a
// policy template.
type PolicyDefinitionDetailMemberTemplateLinked struct {
Value TemplateLinkedPolicyDefinitionDetail
noSmithyDocumentSerde
}
func (*PolicyDefinitionDetailMemberTemplateLinked) isPolicyDefinitionDetail() {}
// A structure that describes a [PolicyDefinintion]. It will always have either an StaticPolicy or a
// TemplateLinkedPolicy element.
//
// This data type is used as a response parameter for the [CreatePolicy] and [ListPolicies] operations.
//
// The following types satisfy this interface:
//
// PolicyDefinitionItemMemberStatic
// PolicyDefinitionItemMemberTemplateLinked
//
// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html
// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html
// [PolicyDefinintion]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html
type PolicyDefinitionItem interface {
isPolicyDefinitionItem()
}
// Information about a static policy that wasn't created with a policy template.
type PolicyDefinitionItemMemberStatic struct {
Value StaticPolicyDefinitionItem
noSmithyDocumentSerde
}
func (*PolicyDefinitionItemMemberStatic) isPolicyDefinitionItem() {}
// Information about a template-linked policy that was created by instantiating a
// policy template.
type PolicyDefinitionItemMemberTemplateLinked struct {
Value TemplateLinkedPolicyDefinitionItem
noSmithyDocumentSerde
}
func (*PolicyDefinitionItemMemberTemplateLinked) isPolicyDefinitionItem() {}
// Contains information about a filter to refine policies returned in a query.
//
// This data type is used as a response parameter for the [ListPolicies] operation.
//
// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html
type PolicyFilter struct {
// Filters the output to only template-linked policies that were instantiated from
// the specified policy template.
PolicyTemplateId *string
// Filters the output to only policies of the specified type.
PolicyType PolicyType
// Filters the output to only policies that reference the specified principal.
Principal EntityReference
// Filters the output to only policies that reference the specified resource.
Resource EntityReference
noSmithyDocumentSerde
}
// Contains information about a policy.
//
// This data type is used as a response parameter for the [ListPolicies] operation.
//
// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html
type PolicyItem struct {
// The date and time the policy was created.
//
// This member is required.
CreatedDate *time.Time
// The policy definition of an item in the list of policies returned.
//
// This member is required.
Definition PolicyDefinitionItem
// The date and time the policy was most recently updated.
//
// This member is required.
LastUpdatedDate *time.Time
// The identifier of the policy you want information about.
//
// This member is required.
PolicyId *string
// The identifier of the PolicyStore where the policy you want information about
// is stored.
//
// This member is required.
PolicyStoreId *string
// The type of the policy. This is one of the following values:
//
// - static
//
// - templateLinked
//
// This member is required.
PolicyType PolicyType
// The action that a policy permits or forbids. For example, {"actions":
// [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID":
// "SharePhoto", "entityType": "PhotoFlash::Action"}]} .
Actions []ActionIdentifier
// The effect of the decision that a policy returns to an authorization request.
// For example, "effect": "Permit" .
Effect PolicyEffect
// The principal associated with the policy.
Principal *EntityIdentifier
// The resource associated with the policy.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a policy store.
//
// This data type is used as a response parameter for the [ListPolicyStores] operation.
//
// [ListPolicyStores]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html
type PolicyStoreItem struct {
// The Amazon Resource Name (ARN) of the policy store.
//
// This member is required.
Arn *string
// The date and time the policy was created.
//
// This member is required.
CreatedDate *time.Time
// The unique identifier of the policy store.
//
// This member is required.
PolicyStoreId *string
// Descriptive text that you can provide to help with identification of the
// current policy store.
Description *string
// The date and time the policy store was most recently updated.
LastUpdatedDate *time.Time
noSmithyDocumentSerde
}
// Contains details about a policy template
//
// This data type is used as a response parameter for the [ListPolicyTemplates] operation.
//
// [ListPolicyTemplates]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html
type PolicyTemplateItem struct {
// The date and time that the policy template was created.
//
// This member is required.
CreatedDate *time.Time
// The date and time that the policy template was most recently updated.
//
// This member is required.
LastUpdatedDate *time.Time
// The unique identifier of the policy store that contains the template.
//
// This member is required.
PolicyStoreId *string
// The unique identifier of the policy template.
//
// This member is required.
PolicyTemplateId *string
// The description attached to the policy template.
Description *string
noSmithyDocumentSerde
}
// Contains information about a resource conflict.
type ResourceConflict struct {
// The unique identifier of the resource involved in a conflict.
//
// This member is required.
ResourceId *string
// The type of the resource involved in a conflict.
//
// This member is required.
ResourceType ResourceType
noSmithyDocumentSerde
}
// Contains a list of principal types, resource types, and actions that can be
// specified in policies stored in the same policy store. If the validation mode
// for the policy store is set to STRICT , then policies that can't be validated by
// this schema are rejected by Verified Permissions and can't be stored in the
// policy store.
//
// The following types satisfy this interface:
//
// SchemaDefinitionMemberCedarJson
type SchemaDefinition interface {
isSchemaDefinition()
}
// A JSON string representation of the schema supported by applications that use
// this policy store. For more information, see [Policy store schema]in the Amazon Verified Permissions
// User Guide.
//
// [Policy store schema]: https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html
type SchemaDefinitionMemberCedarJson struct {
Value string
noSmithyDocumentSerde
}
func (*SchemaDefinitionMemberCedarJson) isSchemaDefinition() {}
// Contains information about a static policy.
//
// This data type is used as a field that is part of the [PolicyDefinitionDetail] type.
//
// [PolicyDefinitionDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html
type StaticPolicyDefinition struct {
// The policy content of the static policy, written in the Cedar policy language.
//
// This member is required.
Statement *string
// The description of the static policy.
Description *string
noSmithyDocumentSerde
}
// A structure that contains details about a static policy. It includes the
// description and policy body.
//
// This data type is used within a [PolicyDefinition] structure as part of a request parameter for
// the [CreatePolicy]operation.
//
// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html
// [PolicyDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html
type StaticPolicyDefinitionDetail struct {
// The content of the static policy written in the Cedar policy language.
//
// This member is required.
Statement *string
// A description of the static policy.
Description *string
noSmithyDocumentSerde
}
// A structure that contains details about a static policy. It includes the
// description and policy statement.
//
// This data type is used within a [PolicyDefinition] structure as part of a request parameter for
// the [CreatePolicy]operation.
//
// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html
// [PolicyDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html
type StaticPolicyDefinitionItem struct {
// A description of the static policy.
Description *string
noSmithyDocumentSerde
}
// Contains information about a policy created by instantiating a policy template.
type TemplateLinkedPolicyDefinition struct {
// The unique identifier of the policy template used to create this policy.
//
// This member is required.
PolicyTemplateId *string
// The principal associated with this template-linked policy. Verified Permissions
// substitutes this principal for the ?principal placeholder in the policy
// template when it evaluates an authorization request.
Principal *EntityIdentifier
// The resource associated with this template-linked policy. Verified Permissions
// substitutes this resource for the ?resource placeholder in the policy template
// when it evaluates an authorization request.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a policy that was created by instantiating a policy
// template.
type TemplateLinkedPolicyDefinitionDetail struct {
// The unique identifier of the policy template used to create this policy.
//
// This member is required.
PolicyTemplateId *string
// The principal associated with this template-linked policy. Verified Permissions
// substitutes this principal for the ?principal placeholder in the policy
// template when it evaluates an authorization request.
Principal *EntityIdentifier
// The resource associated with this template-linked policy. Verified Permissions
// substitutes this resource for the ?resource placeholder in the policy template
// when it evaluates an authorization request.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// Contains information about a policy created by instantiating a policy template.
//
// This
type TemplateLinkedPolicyDefinitionItem struct {
// The unique identifier of the policy template used to create this policy.
//
// This member is required.
PolicyTemplateId *string
// The principal associated with this template-linked policy. Verified Permissions
// substitutes this principal for the ?principal placeholder in the policy
// template when it evaluates an authorization request.
Principal *EntityIdentifier
// The resource associated with this template-linked policy. Verified Permissions
// substitutes this resource for the ?resource placeholder in the policy template
// when it evaluates an authorization request.
Resource *EntityIdentifier
noSmithyDocumentSerde
}
// The user group entities from an Amazon Cognito user pool identity source.
type UpdateCognitoGroupConfiguration struct {
// The name of the schema entity type that's mapped to the user pool group.
// Defaults to AWS::CognitoGroup .
//
// This member is required.
GroupEntityType *string
noSmithyDocumentSerde
}
// Contains configuration details of a Amazon Cognito user pool for use with an
// identity source.
type UpdateCognitoUserPoolConfiguration struct {
// The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool associated with this identity source.
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
//
// This member is required.
UserPoolArn *string
// The client ID of an app client that is configured for the specified Amazon
// Cognito user pool.
ClientIds []string
// The configuration of the user groups from an Amazon Cognito user pool identity
// source.
GroupConfiguration *UpdateCognitoGroupConfiguration
noSmithyDocumentSerde
}
// Contains an update to replace the configuration in an existing identity source.
//
// The following types satisfy this interface:
//
// UpdateConfigurationMemberCognitoUserPoolConfiguration
// UpdateConfigurationMemberOpenIdConnectConfiguration
type UpdateConfiguration interface {
isUpdateConfiguration()
}
// Contains configuration details of a Amazon Cognito user pool.
type UpdateConfigurationMemberCognitoUserPoolConfiguration struct {
Value UpdateCognitoUserPoolConfiguration
noSmithyDocumentSerde
}
func (*UpdateConfigurationMemberCognitoUserPoolConfiguration) isUpdateConfiguration() {}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
type UpdateConfigurationMemberOpenIdConnectConfiguration struct {
Value UpdateOpenIdConnectConfiguration
noSmithyDocumentSerde
}
func (*UpdateConfigurationMemberOpenIdConnectConfiguration) isUpdateConfiguration() {}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// access token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [UpdateOpenIdConnectTokenSelection] structure, which is a parameter to [UpdateIdentitySource].
//
// [UpdateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html
// [UpdateOpenIdConnectTokenSelection]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectTokenSelection.html
type UpdateOpenIdConnectAccessTokenConfiguration struct {
// The access token aud claim values that you want to accept in your policy store.
// For example, https://myapp.example.com, https://myapp2.example.com .
Audiences []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// Contains configuration details of an OpenID Connect (OIDC) identity provider,
// or identity source, that Verified Permissions can use to generate entities from
// authenticated identities. It specifies the issuer URL, token type that you want
// to use, and policy store entity details.
//
// This data type is part of a [UpdateConfiguration] structure, which is a parameter to [UpdateIdentitySource].
//
// [UpdateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html
// [UpdateConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateConfiguration.html
type UpdateOpenIdConnectConfiguration struct {
// The issuer URL of an OIDC identity provider. This URL must have an OIDC
// discovery endpoint at the path .well-known/openid-configuration .
//
// This member is required.
Issuer *string
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This member is required.
TokenSelection UpdateOpenIdConnectTokenSelection
// A descriptive string that you want to prefix to user entities from your OIDC
// identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider ,
// you can reference principals in your policies in the format
// MyCorp::User::MyOIDCProvider|Carlos .
EntityIdPrefix *string
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
GroupConfiguration *UpdateOpenIdConnectGroupConfiguration
noSmithyDocumentSerde
}
// The claim in OIDC identity provider tokens that indicates a user's group
// membership, and the entity type that you want to map it to. For example, this
// object can map the contents of a groups claim to MyCorp::UserGroup .
//
// This data type is part of a [UpdateOpenIdConnectConfiguration] structure, which is a parameter to [UpdateIdentitySource].
//
// [UpdateOpenIdConnectConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html
// [UpdateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html
type UpdateOpenIdConnectGroupConfiguration struct {
// The token claim that you want Verified Permissions to interpret as group
// membership. For example, groups .
//
// This member is required.
GroupClaim *string
// The policy store entity type that you want to map your users' group claim to.
// For example, MyCorp::UserGroup . A group entity type is an entity that can have
// a user entity type as a member.
//
// This member is required.
GroupEntityType *string
noSmithyDocumentSerde
}
// The configuration of an OpenID Connect (OIDC) identity source for handling
// identity (ID) token claims. Contains the claim that you want to identify as the
// principal in an authorization request, and the values of the aud claim, or
// audiences, that you want to accept.
//
// This data type is part of a [UpdateOpenIdConnectTokenSelection] structure, which is a parameter to [UpdateIdentitySource].
//
// [UpdateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html
// [UpdateOpenIdConnectTokenSelection]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectTokenSelection.html
type UpdateOpenIdConnectIdentityTokenConfiguration struct {
// The ID token audience, or client ID, claim values that you want to accept in
// your policy store from an OIDC identity provider. For example,
// 1example23456789, 2example10111213 .
ClientIds []string
// The claim that determines the principal in OIDC access tokens. For example, sub .
PrincipalIdClaim *string
noSmithyDocumentSerde
}
// The token type that you want to process from your OIDC identity provider. Your
// policy store can process either identity (ID) or access tokens from a given OIDC
// identity source.
//
// This data type is part of a [UpdateOpenIdConnectConfiguration] structure, which is a parameter to [UpdateIdentitySource].
//
// The following types satisfy this interface:
//
// UpdateOpenIdConnectTokenSelectionMemberAccessTokenOnly
// UpdateOpenIdConnectTokenSelectionMemberIdentityTokenOnly
//
// [UpdateOpenIdConnectConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html
// [UpdateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html
type UpdateOpenIdConnectTokenSelection interface {
isUpdateOpenIdConnectTokenSelection()
}
// The OIDC configuration for processing access tokens. Contains allowed audience
// claims, for example https://auth.example.com , and the claim that you want to
// map to the principal, for example sub .
type UpdateOpenIdConnectTokenSelectionMemberAccessTokenOnly struct {
Value UpdateOpenIdConnectAccessTokenConfiguration
noSmithyDocumentSerde
}
func (*UpdateOpenIdConnectTokenSelectionMemberAccessTokenOnly) isUpdateOpenIdConnectTokenSelection() {
}
// The OIDC configuration for processing identity (ID) tokens. Contains allowed
// client ID claims, for example 1example23456789 , and the claim that you want to
// map to the principal, for example sub .
type UpdateOpenIdConnectTokenSelectionMemberIdentityTokenOnly struct {
Value UpdateOpenIdConnectIdentityTokenConfiguration
noSmithyDocumentSerde
}
func (*UpdateOpenIdConnectTokenSelectionMemberIdentityTokenOnly) isUpdateOpenIdConnectTokenSelection() {
}
// Contains information about updates to be applied to a policy.
//
// This data type is used as a request parameter in the [UpdatePolicy] operation.
//
// The following types satisfy this interface:
//
// UpdatePolicyDefinitionMemberStatic
//
// [UpdatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html
type UpdatePolicyDefinition interface {
isUpdatePolicyDefinition()
}
// Contains details about the updates to be applied to a static policy.
type UpdatePolicyDefinitionMemberStatic struct {
Value UpdateStaticPolicyDefinition
noSmithyDocumentSerde
}
func (*UpdatePolicyDefinitionMemberStatic) isUpdatePolicyDefinition() {}
// Contains information about an update to a static policy.
type UpdateStaticPolicyDefinition struct {
// Specifies the Cedar policy language text to be added to or replaced on the
// static policy.
//
// You can change only the following elements from the original content:
//
// - The action referenced by the policy.
//
// - Any conditional clauses, such as when or unless clauses.
//
// You can't change the following elements:
//
// - Changing from StaticPolicy to TemplateLinkedPolicy .
//
// - The effect ( permit or forbid ) of the policy.
//
// - The principal referenced by the policy.
//
// - The resource referenced by the policy.
//
// This member is required.
Statement *string
// Specifies the description to be added to or replaced on the static policy.
Description *string
noSmithyDocumentSerde
}
// Details about a field that failed policy validation.
type ValidationExceptionField struct {
// Describes the policy validation error.
//
// This member is required.
Message *string
// The path to the specific element that Verified Permissions found to be not
// valid.
//
// This member is required.
Path *string
noSmithyDocumentSerde
}
// A structure that contains Cedar policy validation settings for the policy
// store. The validation mode determines which validation failures that Cedar
// considers serious enough to block acceptance of a new or edited static policy or
// policy template.
//
// This data type is used as a request parameter in the [CreatePolicyStore] and [UpdatePolicyStore] operations.
//
// [UpdatePolicyStore]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html
// [CreatePolicyStore]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html
type ValidationSettings struct {
// The validation mode currently configured for this policy store. The valid
// values are:
//
// - OFF – Neither Verified Permissions nor Cedar perform any validation on
// policies. No validation errors are reported by either service.
//
// - STRICT – Requires a schema to be present in the policy store. Cedar
// performs validation on all submitted new or updated static policies and policy
// templates. Any that fail validation are rejected and Cedar doesn't store them in
// the policy store.
//
// If Mode=STRICT and the policy store doesn't contain a schema, Verified
// Permissions rejects all static policies and policy templates because there is no
// schema to validate against.
//
// To submit a static policy or policy template without a schema, you must turn
// off validation.
//
// This member is required.
Mode ValidationMode
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
Tag string
Value []byte
noSmithyDocumentSerde
}
func (*UnknownUnionMember) isAttributeValue() {}
func (*UnknownUnionMember) isConfiguration() {}
func (*UnknownUnionMember) isConfigurationDetail() {}
func (*UnknownUnionMember) isConfigurationItem() {}
func (*UnknownUnionMember) isContextDefinition() {}
func (*UnknownUnionMember) isEntitiesDefinition() {}
func (*UnknownUnionMember) isEntityReference() {}
func (*UnknownUnionMember) isOpenIdConnectTokenSelection() {}
func (*UnknownUnionMember) isOpenIdConnectTokenSelectionDetail() {}
func (*UnknownUnionMember) isOpenIdConnectTokenSelectionItem() {}
func (*UnknownUnionMember) isPolicyDefinition() {}
func (*UnknownUnionMember) isPolicyDefinitionDetail() {}
func (*UnknownUnionMember) isPolicyDefinitionItem() {}
func (*UnknownUnionMember) isSchemaDefinition() {}
func (*UnknownUnionMember) isUpdateConfiguration() {}
func (*UnknownUnionMember) isUpdateOpenIdConnectTokenSelection() {}
func (*UnknownUnionMember) isUpdatePolicyDefinition() {}
|