@aws-sdk/client-verifiedpermissions 3.352.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +461 -0
  3. package/dist-cjs/VerifiedPermissions.js +59 -0
  4. package/dist-cjs/VerifiedPermissionsClient.js +41 -0
  5. package/dist-cjs/commands/CreateIdentitySourceCommand.js +46 -0
  6. package/dist-cjs/commands/CreatePolicyCommand.js +46 -0
  7. package/dist-cjs/commands/CreatePolicyStoreCommand.js +46 -0
  8. package/dist-cjs/commands/CreatePolicyTemplateCommand.js +46 -0
  9. package/dist-cjs/commands/DeleteIdentitySourceCommand.js +46 -0
  10. package/dist-cjs/commands/DeletePolicyCommand.js +46 -0
  11. package/dist-cjs/commands/DeletePolicyStoreCommand.js +46 -0
  12. package/dist-cjs/commands/DeletePolicyTemplateCommand.js +46 -0
  13. package/dist-cjs/commands/GetIdentitySourceCommand.js +46 -0
  14. package/dist-cjs/commands/GetPolicyCommand.js +46 -0
  15. package/dist-cjs/commands/GetPolicyStoreCommand.js +46 -0
  16. package/dist-cjs/commands/GetPolicyTemplateCommand.js +46 -0
  17. package/dist-cjs/commands/GetSchemaCommand.js +46 -0
  18. package/dist-cjs/commands/IsAuthorizedCommand.js +46 -0
  19. package/dist-cjs/commands/IsAuthorizedWithTokenCommand.js +46 -0
  20. package/dist-cjs/commands/ListIdentitySourcesCommand.js +46 -0
  21. package/dist-cjs/commands/ListPoliciesCommand.js +46 -0
  22. package/dist-cjs/commands/ListPolicyStoresCommand.js +46 -0
  23. package/dist-cjs/commands/ListPolicyTemplatesCommand.js +46 -0
  24. package/dist-cjs/commands/PutSchemaCommand.js +46 -0
  25. package/dist-cjs/commands/UpdateIdentitySourceCommand.js +46 -0
  26. package/dist-cjs/commands/UpdatePolicyCommand.js +46 -0
  27. package/dist-cjs/commands/UpdatePolicyStoreCommand.js +46 -0
  28. package/dist-cjs/commands/UpdatePolicyTemplateCommand.js +46 -0
  29. package/dist-cjs/commands/index.js +27 -0
  30. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  31. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  32. package/dist-cjs/endpoint/ruleset.js +7 -0
  33. package/dist-cjs/index.js +11 -0
  34. package/dist-cjs/models/VerifiedPermissionsServiceException.js +12 -0
  35. package/dist-cjs/models/index.js +4 -0
  36. package/dist-cjs/models/models_0.js +237 -0
  37. package/dist-cjs/pagination/Interfaces.js +2 -0
  38. package/dist-cjs/pagination/ListIdentitySourcesPaginator.js +29 -0
  39. package/dist-cjs/pagination/ListPoliciesPaginator.js +29 -0
  40. package/dist-cjs/pagination/ListPolicyStoresPaginator.js +29 -0
  41. package/dist-cjs/pagination/ListPolicyTemplatesPaginator.js +29 -0
  42. package/dist-cjs/pagination/index.js +8 -0
  43. package/dist-cjs/protocols/Aws_json1_0.js +1772 -0
  44. package/dist-cjs/runtimeConfig.browser.js +39 -0
  45. package/dist-cjs/runtimeConfig.js +48 -0
  46. package/dist-cjs/runtimeConfig.native.js +15 -0
  47. package/dist-cjs/runtimeConfig.shared.js +21 -0
  48. package/dist-es/VerifiedPermissions.js +55 -0
  49. package/dist-es/VerifiedPermissionsClient.js +37 -0
  50. package/dist-es/commands/CreateIdentitySourceCommand.js +42 -0
  51. package/dist-es/commands/CreatePolicyCommand.js +42 -0
  52. package/dist-es/commands/CreatePolicyStoreCommand.js +42 -0
  53. package/dist-es/commands/CreatePolicyTemplateCommand.js +42 -0
  54. package/dist-es/commands/DeleteIdentitySourceCommand.js +42 -0
  55. package/dist-es/commands/DeletePolicyCommand.js +42 -0
  56. package/dist-es/commands/DeletePolicyStoreCommand.js +42 -0
  57. package/dist-es/commands/DeletePolicyTemplateCommand.js +42 -0
  58. package/dist-es/commands/GetIdentitySourceCommand.js +42 -0
  59. package/dist-es/commands/GetPolicyCommand.js +42 -0
  60. package/dist-es/commands/GetPolicyStoreCommand.js +42 -0
  61. package/dist-es/commands/GetPolicyTemplateCommand.js +42 -0
  62. package/dist-es/commands/GetSchemaCommand.js +42 -0
  63. package/dist-es/commands/IsAuthorizedCommand.js +42 -0
  64. package/dist-es/commands/IsAuthorizedWithTokenCommand.js +42 -0
  65. package/dist-es/commands/ListIdentitySourcesCommand.js +42 -0
  66. package/dist-es/commands/ListPoliciesCommand.js +42 -0
  67. package/dist-es/commands/ListPolicyStoresCommand.js +42 -0
  68. package/dist-es/commands/ListPolicyTemplatesCommand.js +42 -0
  69. package/dist-es/commands/PutSchemaCommand.js +42 -0
  70. package/dist-es/commands/UpdateIdentitySourceCommand.js +42 -0
  71. package/dist-es/commands/UpdatePolicyCommand.js +42 -0
  72. package/dist-es/commands/UpdatePolicyStoreCommand.js +42 -0
  73. package/dist-es/commands/UpdatePolicyTemplateCommand.js +42 -0
  74. package/dist-es/commands/index.js +24 -0
  75. package/dist-es/endpoint/EndpointParameters.js +8 -0
  76. package/dist-es/endpoint/endpointResolver.js +8 -0
  77. package/dist-es/endpoint/ruleset.js +4 -0
  78. package/dist-es/index.js +6 -0
  79. package/dist-es/models/VerifiedPermissionsServiceException.js +8 -0
  80. package/dist-es/models/index.js +1 -0
  81. package/dist-es/models/models_0.js +227 -0
  82. package/dist-es/pagination/Interfaces.js +1 -0
  83. package/dist-es/pagination/ListIdentitySourcesPaginator.js +25 -0
  84. package/dist-es/pagination/ListPoliciesPaginator.js +25 -0
  85. package/dist-es/pagination/ListPolicyStoresPaginator.js +25 -0
  86. package/dist-es/pagination/ListPolicyTemplatesPaginator.js +25 -0
  87. package/dist-es/pagination/index.js +5 -0
  88. package/dist-es/protocols/Aws_json1_0.js +1721 -0
  89. package/dist-es/runtimeConfig.browser.js +34 -0
  90. package/dist-es/runtimeConfig.js +43 -0
  91. package/dist-es/runtimeConfig.native.js +11 -0
  92. package/dist-es/runtimeConfig.shared.js +17 -0
  93. package/dist-types/VerifiedPermissions.d.ts +242 -0
  94. package/dist-types/VerifiedPermissionsClient.d.ts +250 -0
  95. package/dist-types/commands/CreateIdentitySourceCommand.d.ts +210 -0
  96. package/dist-types/commands/CreatePolicyCommand.d.ts +222 -0
  97. package/dist-types/commands/CreatePolicyStoreCommand.d.ts +175 -0
  98. package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +184 -0
  99. package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +175 -0
  100. package/dist-types/commands/DeletePolicyCommand.d.ts +174 -0
  101. package/dist-types/commands/DeletePolicyStoreCommand.d.ts +166 -0
  102. package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +177 -0
  103. package/dist-types/commands/GetIdentitySourceCommand.d.ts +182 -0
  104. package/dist-types/commands/GetPolicyCommand.d.ts +199 -0
  105. package/dist-types/commands/GetPolicyStoreCommand.d.ts +175 -0
  106. package/dist-types/commands/GetPolicyTemplateCommand.d.ts +175 -0
  107. package/dist-types/commands/GetSchemaCommand.d.ts +172 -0
  108. package/dist-types/commands/IsAuthorizedCommand.d.ts +239 -0
  109. package/dist-types/commands/IsAuthorizedWithTokenCommand.d.ts +240 -0
  110. package/dist-types/commands/ListIdentitySourcesCommand.d.ts +193 -0
  111. package/dist-types/commands/ListPoliciesCommand.d.ts +222 -0
  112. package/dist-types/commands/ListPolicyStoresCommand.d.ts +174 -0
  113. package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +180 -0
  114. package/dist-types/commands/PutSchemaCommand.d.ts +188 -0
  115. package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +187 -0
  116. package/dist-types/commands/UpdatePolicyCommand.d.ts +202 -0
  117. package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +179 -0
  118. package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +184 -0
  119. package/dist-types/commands/index.d.ts +24 -0
  120. package/dist-types/endpoint/EndpointParameters.d.ts +20 -0
  121. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  122. package/dist-types/endpoint/ruleset.d.ts +2 -0
  123. package/dist-types/index.d.ts +75 -0
  124. package/dist-types/models/VerifiedPermissionsServiceException.d.ts +13 -0
  125. package/dist-types/models/index.d.ts +1 -0
  126. package/dist-types/models/models_0.d.ts +2456 -0
  127. package/dist-types/pagination/Interfaces.d.ts +8 -0
  128. package/dist-types/pagination/ListIdentitySourcesPaginator.d.ts +7 -0
  129. package/dist-types/pagination/ListPoliciesPaginator.d.ts +7 -0
  130. package/dist-types/pagination/ListPolicyStoresPaginator.d.ts +7 -0
  131. package/dist-types/pagination/ListPolicyTemplatesPaginator.d.ts +7 -0
  132. package/dist-types/pagination/index.d.ts +5 -0
  133. package/dist-types/protocols/Aws_json1_0.d.ts +218 -0
  134. package/dist-types/runtimeConfig.browser.d.ts +42 -0
  135. package/dist-types/runtimeConfig.d.ts +42 -0
  136. package/dist-types/runtimeConfig.native.d.ts +41 -0
  137. package/dist-types/runtimeConfig.shared.d.ts +18 -0
  138. package/dist-types/ts3.4/VerifiedPermissions.d.ts +415 -0
  139. package/dist-types/ts3.4/VerifiedPermissionsClient.d.ts +259 -0
  140. package/dist-types/ts3.4/commands/CreateIdentitySourceCommand.d.ts +42 -0
  141. package/dist-types/ts3.4/commands/CreatePolicyCommand.d.ts +35 -0
  142. package/dist-types/ts3.4/commands/CreatePolicyStoreCommand.d.ts +38 -0
  143. package/dist-types/ts3.4/commands/CreatePolicyTemplateCommand.d.ts +42 -0
  144. package/dist-types/ts3.4/commands/DeleteIdentitySourceCommand.d.ts +42 -0
  145. package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +35 -0
  146. package/dist-types/ts3.4/commands/DeletePolicyStoreCommand.d.ts +38 -0
  147. package/dist-types/ts3.4/commands/DeletePolicyTemplateCommand.d.ts +42 -0
  148. package/dist-types/ts3.4/commands/GetIdentitySourceCommand.d.ts +38 -0
  149. package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +35 -0
  150. package/dist-types/ts3.4/commands/GetPolicyStoreCommand.d.ts +35 -0
  151. package/dist-types/ts3.4/commands/GetPolicyTemplateCommand.d.ts +38 -0
  152. package/dist-types/ts3.4/commands/GetSchemaCommand.d.ts +35 -0
  153. package/dist-types/ts3.4/commands/IsAuthorizedCommand.d.ts +35 -0
  154. package/dist-types/ts3.4/commands/IsAuthorizedWithTokenCommand.d.ts +42 -0
  155. package/dist-types/ts3.4/commands/ListIdentitySourcesCommand.d.ts +39 -0
  156. package/dist-types/ts3.4/commands/ListPoliciesCommand.d.ts +35 -0
  157. package/dist-types/ts3.4/commands/ListPolicyStoresCommand.d.ts +38 -0
  158. package/dist-types/ts3.4/commands/ListPolicyTemplatesCommand.d.ts +39 -0
  159. package/dist-types/ts3.4/commands/PutSchemaCommand.d.ts +35 -0
  160. package/dist-types/ts3.4/commands/UpdateIdentitySourceCommand.d.ts +42 -0
  161. package/dist-types/ts3.4/commands/UpdatePolicyCommand.d.ts +35 -0
  162. package/dist-types/ts3.4/commands/UpdatePolicyStoreCommand.d.ts +38 -0
  163. package/dist-types/ts3.4/commands/UpdatePolicyTemplateCommand.d.ts +42 -0
  164. package/dist-types/ts3.4/commands/index.d.ts +24 -0
  165. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +32 -0
  166. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  167. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  168. package/dist-types/ts3.4/index.d.ts +6 -0
  169. package/dist-types/ts3.4/models/VerifiedPermissionsServiceException.d.ts +8 -0
  170. package/dist-types/ts3.4/models/index.d.ts +1 -0
  171. package/dist-types/ts3.4/models/models_0.d.ts +757 -0
  172. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  173. package/dist-types/ts3.4/pagination/ListIdentitySourcesPaginator.d.ts +11 -0
  174. package/dist-types/ts3.4/pagination/ListPoliciesPaginator.d.ts +11 -0
  175. package/dist-types/ts3.4/pagination/ListPolicyStoresPaginator.d.ts +11 -0
  176. package/dist-types/ts3.4/pagination/ListPolicyTemplatesPaginator.d.ts +11 -0
  177. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  178. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +293 -0
  179. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +96 -0
  180. package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
  181. package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
  182. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +20 -0
  183. package/package.json +101 -0
@@ -0,0 +1,75 @@
1
+ /**
2
+ * <p>Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage
3
+ * permissions for your application, and authorize user access based on those permissions.
4
+ * Using Verified Permissions, application developers can grant access based on information about the
5
+ * users, resources, and requested actions. You can also evaluate additional information
6
+ * like group membership, attributes of the resources, and session context, such as time of
7
+ * request and IP addresses. Verified Permissions manages these permissions by letting you create and
8
+ * store authorization policies for your applications, such as consumer-facing web sites
9
+ * and enterprise business systems.</p>
10
+ * <p>Verified Permissions uses Cedar as the policy language to express your permission requirements.
11
+ * Cedar supports both role-based access control (RBAC) and attribute-based access
12
+ * control (ABAC) authorization models.</p>
13
+ * <p>For more information about configuring, administering, and using Amazon Verified Permissions in your
14
+ * applications, see the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/">Amazon Verified Permissions User Guide</a>.</p>
15
+ * <p>For more information about the Cedar policy language, see the <a href="docs.cedarpolicy.com">Cedar Policy Language Guide</a>.</p>
16
+ * <important>
17
+ * <p>When you write Cedar policies that reference principals, resources and actions,
18
+ * you can define the unique identifiers used for each of those elements. We strongly
19
+ * recommend that you follow these best practices:</p>
20
+ * <ul>
21
+ * <li>
22
+ * <p>
23
+ * <b>Use values like universally unique identifiers
24
+ * (UUIDs) for all principal and resource identifiers.</b>
25
+ * </p>
26
+ * <p>For example, if user <code>jane</code> leaves the company, and you later
27
+ * let someone else use the name <code>jane</code>, then that new user
28
+ * automatically gets access to everything granted by policies that still
29
+ * reference <code>User::"jane"</code>. Cedar can’t distinguish between the
30
+ * new user and the old. This applies to both principal and resource
31
+ * identifiers. Always use identifiers that are guaranteed unique and never
32
+ * reused to ensure that you don’t unintentionally grant access because of the
33
+ * presence of an old identifier in a policy.</p>
34
+ * <p>Where you use a UUID for an entity, we recommend that you follow it with
35
+ * the // comment specifier and the ‘friendly’ name of your entity. This helps
36
+ * to make your policies easier to understand. For example: principal ==
37
+ * User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice</p>
38
+ * </li>
39
+ * <li>
40
+ * <p>
41
+ * <b>Do not include personally identifying, confidential,
42
+ * or sensitive information as part of the unique identifier for your
43
+ * principals or resources.</b> These identifiers are included in
44
+ * log entries shared in CloudTrail trails.</p>
45
+ * </li>
46
+ * </ul>
47
+ * </important>
48
+ * <p>Several operations return structures that appear similar, but have different purposes.
49
+ * As new functionality is added to the product, the structure used in a parameter of one
50
+ * operation might need to change in a way that wouldn't make sense for the same parameter
51
+ * in a different operation. To help you understand the purpose of each, the following
52
+ * naming convention is used for the structures:</p>
53
+ * <ul>
54
+ * <li>
55
+ * <p>Parameters that end in <code>Detail</code> are used in <code>Get</code>
56
+ * operations.</p>
57
+ * </li>
58
+ * <li>
59
+ * <p>Parameters that end in <code>Item</code> are used in <code>List</code>
60
+ * operations.</p>
61
+ * </li>
62
+ * <li>
63
+ * <p>Parameters that use neither suffix are used in the mutating (create and
64
+ * update) operations.</p>
65
+ * </li>
66
+ * </ul>
67
+ *
68
+ * @packageDocumentation
69
+ */
70
+ export * from "./VerifiedPermissionsClient";
71
+ export * from "./VerifiedPermissions";
72
+ export * from "./commands";
73
+ export * from "./pagination";
74
+ export * from "./models";
75
+ export { VerifiedPermissionsServiceException } from "./models/VerifiedPermissionsServiceException";
@@ -0,0 +1,13 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ export { __ServiceException, __ServiceExceptionOptions };
3
+ /**
4
+ * @public
5
+ *
6
+ * Base exception class for all service exceptions from VerifiedPermissions service.
7
+ */
8
+ export declare class VerifiedPermissionsServiceException extends __ServiceException {
9
+ /**
10
+ * @internal
11
+ */
12
+ constructor(options: __ServiceExceptionOptions);
13
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";