@pulumi/okta 4.6.2 → 4.6.3

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 (397) hide show
  1. package/adminRoleCustom.d.ts +129 -10
  2. package/adminRoleCustom.js +24 -1
  3. package/adminRoleCustom.js.map +1 -1
  4. package/adminRoleCustomAssignments.d.ts +25 -10
  5. package/adminRoleCustomAssignments.js +13 -1
  6. package/adminRoleCustomAssignments.js.map +1 -1
  7. package/adminRoleTargets.d.ts +44 -14
  8. package/adminRoleTargets.js +30 -0
  9. package/adminRoleTargets.js.map +1 -1
  10. package/app/accessPolicyAssignment.d.ts +20 -1
  11. package/app/accessPolicyAssignment.js +20 -1
  12. package/app/accessPolicyAssignment.js.map +1 -1
  13. package/app/autoLogin.d.ts +119 -72
  14. package/app/autoLogin.js +47 -0
  15. package/app/autoLogin.js.map +1 -1
  16. package/app/basicAuth.d.ts +66 -38
  17. package/app/basicAuth.js +28 -0
  18. package/app/basicAuth.js.map +1 -1
  19. package/app/bookmark.d.ts +71 -35
  20. package/app/bookmark.js +27 -0
  21. package/app/bookmark.js.map +1 -1
  22. package/app/getApp.d.ts +25 -58
  23. package/app/getApp.js +2 -2
  24. package/app/getApp.js.map +1 -1
  25. package/app/getMetadataSaml.d.ts +5 -11
  26. package/app/getMetadataSaml.js +2 -2
  27. package/app/getMetadataSaml.js.map +1 -1
  28. package/app/getOauth.d.ts +34 -62
  29. package/app/getOauth.js +2 -2
  30. package/app/getOauth.js.map +1 -1
  31. package/app/getSaml.d.ts +55 -75
  32. package/app/getSaml.js +2 -2
  33. package/app/getSaml.js.map +1 -1
  34. package/app/groupAssignment.d.ts +15 -6
  35. package/app/groupAssignment.js +9 -0
  36. package/app/groupAssignment.js.map +1 -1
  37. package/app/oauth.d.ts +301 -123
  38. package/app/oauth.js +82 -0
  39. package/app/oauth.js.map +1 -1
  40. package/app/oauthPostLogoutRedirectUri.d.ts +38 -3
  41. package/app/oauthPostLogoutRedirectUri.js +35 -0
  42. package/app/oauthPostLogoutRedirectUri.js.map +1 -1
  43. package/app/oauthRedirectUri.d.ts +37 -3
  44. package/app/oauthRedirectUri.js +34 -0
  45. package/app/oauthRedirectUri.js.map +1 -1
  46. package/app/saml.d.ts +303 -133
  47. package/app/saml.js +161 -0
  48. package/app/saml.js.map +1 -1
  49. package/app/securePasswordStore.d.ts +109 -79
  50. package/app/securePasswordStore.js +30 -0
  51. package/app/securePasswordStore.js.map +1 -1
  52. package/app/swa.d.ts +102 -72
  53. package/app/swa.js +30 -0
  54. package/app/swa.js.map +1 -1
  55. package/app/threeField.d.ts +87 -72
  56. package/app/threeField.js +15 -0
  57. package/app/threeField.js.map +1 -1
  58. package/app/user.d.ts +37 -12
  59. package/app/user.js +22 -0
  60. package/app/user.js.map +1 -1
  61. package/appGroupAssignments.d.ts +40 -3
  62. package/appGroupAssignments.js +37 -0
  63. package/appGroupAssignments.js.map +1 -1
  64. package/appOauthApiScope.d.ts +36 -3
  65. package/appOauthApiScope.js +33 -0
  66. package/appOauthApiScope.js.map +1 -1
  67. package/appSamlAppSettings.d.ts +44 -6
  68. package/appSamlAppSettings.js +38 -0
  69. package/appSamlAppSettings.js.map +1 -1
  70. package/appSharedCredentials.d.ts +115 -72
  71. package/appSharedCredentials.js +43 -0
  72. package/appSharedCredentials.js.map +1 -1
  73. package/appSignonPolicy.d.ts +44 -6
  74. package/appSignonPolicy.js +38 -0
  75. package/appSignonPolicy.js.map +1 -1
  76. package/appSignonPolicyRule.d.ts +327 -68
  77. package/appSignonPolicyRule.js +244 -0
  78. package/appSignonPolicyRule.js.map +1 -1
  79. package/appUserBaseSchemaProperty.d.ts +52 -24
  80. package/appUserBaseSchemaProperty.js +28 -0
  81. package/appUserBaseSchemaProperty.js.map +1 -1
  82. package/appUserSchemaProperty.d.ts +80 -54
  83. package/appUserSchemaProperty.js +26 -0
  84. package/appUserSchemaProperty.js.map +1 -1
  85. package/auth/getServer.d.ts +11 -11
  86. package/auth/getServer.js +2 -2
  87. package/auth/getServerPolicy.d.ts +9 -15
  88. package/auth/getServerPolicy.js +2 -2
  89. package/auth/getServerPolicy.js.map +1 -1
  90. package/auth/getServerScopes.d.ts +5 -8
  91. package/auth/getServerScopes.js +2 -2
  92. package/auth/getServerScopes.js.map +1 -1
  93. package/auth/server.d.ts +49 -13
  94. package/auth/server.js +27 -0
  95. package/auth/server.js.map +1 -1
  96. package/auth/serverClaim.d.ts +54 -18
  97. package/auth/serverClaim.js +27 -0
  98. package/auth/serverClaim.js.map +1 -1
  99. package/auth/serverPolicy.d.ts +43 -6
  100. package/auth/serverPolicy.js +28 -0
  101. package/auth/serverPolicy.js.map +1 -1
  102. package/auth/serverPolicyRule.d.ts +72 -29
  103. package/auth/serverPolicyRule.js +25 -0
  104. package/auth/serverPolicyRule.js.map +1 -1
  105. package/auth/serverScope.d.ts +41 -15
  106. package/auth/serverScope.js +26 -0
  107. package/auth/serverScope.js.map +1 -1
  108. package/authServerClaimDefault.d.ts +50 -13
  109. package/authServerClaimDefault.js +31 -0
  110. package/authServerClaimDefault.js.map +1 -1
  111. package/authServerDefault.d.ts +47 -13
  112. package/authServerDefault.js +25 -0
  113. package/authServerDefault.js.map +1 -1
  114. package/authenticator.d.ts +94 -38
  115. package/authenticator.js +38 -0
  116. package/authenticator.js.map +1 -1
  117. package/behaviour.d.ts +78 -18
  118. package/behaviour.js +42 -0
  119. package/behaviour.js.map +1 -1
  120. package/brand.d.ts +28 -19
  121. package/brand.js +10 -1
  122. package/brand.js.map +1 -1
  123. package/captcha.d.ts +38 -12
  124. package/captcha.js +26 -0
  125. package/captcha.js.map +1 -1
  126. package/captchaOrgWideSettings.d.ts +51 -6
  127. package/captchaOrgWideSettings.js +45 -0
  128. package/captchaOrgWideSettings.js.map +1 -1
  129. package/domain.d.ts +39 -13
  130. package/domain.js +20 -0
  131. package/domain.js.map +1 -1
  132. package/domainCertificate.d.ts +63 -15
  133. package/domainCertificate.js +48 -0
  134. package/domainCertificate.js.map +1 -1
  135. package/domainVerification.d.ts +22 -3
  136. package/domainVerification.js +19 -0
  137. package/domainVerification.js.map +1 -1
  138. package/emailCustomization.d.ts +224 -3
  139. package/emailCustomization.js +41 -0
  140. package/emailCustomization.js.map +1 -1
  141. package/emailSender.d.ts +39 -13
  142. package/emailSender.js +26 -0
  143. package/emailSender.js.map +1 -1
  144. package/emailSenderVerification.d.ts +26 -3
  145. package/emailSenderVerification.js +23 -0
  146. package/emailSenderVerification.js.map +1 -1
  147. package/eventHook.d.ts +37 -0
  148. package/eventHook.js +37 -0
  149. package/eventHook.js.map +1 -1
  150. package/eventHookVerification.d.ts +37 -3
  151. package/eventHookVerification.js +34 -0
  152. package/eventHookVerification.js.map +1 -1
  153. package/factor/factor.d.ts +23 -6
  154. package/factor/factor.js +14 -0
  155. package/factor/factor.js.map +1 -1
  156. package/factorTotp.d.ts +44 -12
  157. package/factorTotp.js +23 -0
  158. package/factorTotp.js.map +1 -1
  159. package/getAppGroupAssignments.d.ts +6 -6
  160. package/getAppGroupAssignments.js +2 -2
  161. package/getAppSignonPolicy.d.ts +6 -16
  162. package/getAppSignonPolicy.js +4 -8
  163. package/getAppSignonPolicy.js.map +1 -1
  164. package/getAppUserAssignments.d.ts +6 -6
  165. package/getAppUserAssignments.js +2 -2
  166. package/getAuthServerClaim.d.ts +12 -15
  167. package/getAuthServerClaim.js +2 -2
  168. package/getAuthServerClaim.js.map +1 -1
  169. package/getAuthServerClaims.d.ts +5 -8
  170. package/getAuthServerClaims.js +2 -2
  171. package/getAuthServerClaims.js.map +1 -1
  172. package/getAuthenticator.d.ts +26 -24
  173. package/getAuthenticator.js +22 -14
  174. package/getAuthenticator.js.map +1 -1
  175. package/getBehaviour.d.ts +8 -6
  176. package/getBehaviour.js +2 -2
  177. package/getBehaviour.js.map +1 -1
  178. package/getBehaviours.d.ts +7 -7
  179. package/getBehaviours.js +2 -2
  180. package/getBrand.d.ts +6 -9
  181. package/getBrand.js +2 -2
  182. package/getBrand.js.map +1 -1
  183. package/getBrands.d.ts +2 -2
  184. package/getBrands.js +2 -2
  185. package/getEmailCustomization.d.ts +9 -14
  186. package/getEmailCustomization.js +6 -2
  187. package/getEmailCustomization.js.map +1 -1
  188. package/getEmailCustomizations.d.ts +9 -11
  189. package/getEmailCustomizations.js +6 -2
  190. package/getEmailCustomizations.js.map +1 -1
  191. package/getGroups.d.ts +25 -11
  192. package/getGroups.js +2 -2
  193. package/getGroups.js.map +1 -1
  194. package/getNetworkZone.d.ts +12 -12
  195. package/getNetworkZone.js +2 -2
  196. package/getRoleSubscription.d.ts +35 -13
  197. package/getRoleSubscription.js +2 -2
  198. package/getRoleSubscription.js.map +1 -1
  199. package/getTemplate.d.ts +8 -10
  200. package/getTemplate.js +6 -2
  201. package/getTemplate.js.map +1 -1
  202. package/getTemplates.d.ts +7 -6
  203. package/getTemplates.js +6 -2
  204. package/getTemplates.js.map +1 -1
  205. package/getTheme.d.ts +12 -14
  206. package/getTheme.js +6 -2
  207. package/getTheme.js.map +1 -1
  208. package/getThemes.d.ts +7 -6
  209. package/getThemes.js +6 -2
  210. package/getThemes.js.map +1 -1
  211. package/getTrustedOrigins.d.ts +4 -7
  212. package/getTrustedOrigins.js +2 -2
  213. package/getTrustedOrigins.js.map +1 -1
  214. package/getUserSecurityQuestions.d.ts +8 -4
  215. package/getUserSecurityQuestions.js +4 -0
  216. package/getUserSecurityQuestions.js.map +1 -1
  217. package/group/getEveryoneGroup.d.ts +5 -10
  218. package/group/getEveryoneGroup.js +2 -4
  219. package/group/getEveryoneGroup.js.map +1 -1
  220. package/group/getGroup.d.ts +26 -17
  221. package/group/getGroup.js +2 -2
  222. package/group/getGroup.js.map +1 -1
  223. package/group/getRule.d.ts +15 -6
  224. package/group/getRule.js +2 -2
  225. package/group/getRule.js.map +1 -1
  226. package/group/group.d.ts +46 -9
  227. package/group/group.js +37 -0
  228. package/group/group.js.map +1 -1
  229. package/group/role.d.ts +101 -15
  230. package/group/role.js +26 -0
  231. package/group/role.js.map +1 -1
  232. package/group/rule.d.ts +80 -6
  233. package/group/rule.js +23 -0
  234. package/group/rule.js.map +1 -1
  235. package/groupMemberships.d.ts +48 -7
  236. package/groupMemberships.js +42 -1
  237. package/groupMemberships.js.map +1 -1
  238. package/groupSchemaProperty.d.ts +94 -51
  239. package/groupSchemaProperty.js +25 -0
  240. package/groupSchemaProperty.js.map +1 -1
  241. package/idp/getMetadataSaml.d.ts +6 -9
  242. package/idp/getMetadataSaml.js +2 -2
  243. package/idp/getMetadataSaml.js.map +1 -1
  244. package/idp/getOidc.d.ts +9 -9
  245. package/idp/getOidc.js +2 -2
  246. package/idp/getSaml.d.ts +13 -16
  247. package/idp/getSaml.js +2 -2
  248. package/idp/getSaml.js.map +1 -1
  249. package/idp/getSocial.d.ts +2 -8
  250. package/idp/getSocial.js +2 -2
  251. package/idp/getSocial.js.map +1 -1
  252. package/idp/oidc.d.ts +297 -12
  253. package/idp/oidc.js +36 -0
  254. package/idp/oidc.js.map +1 -1
  255. package/idp/saml.d.ts +284 -18
  256. package/idp/saml.js +32 -0
  257. package/idp/saml.js.map +1 -1
  258. package/idp/samlKey.d.ts +48 -3
  259. package/idp/samlKey.js +9 -0
  260. package/idp/samlKey.js.map +1 -1
  261. package/idp/social.d.ts +251 -18
  262. package/idp/social.js +32 -0
  263. package/idp/social.js.map +1 -1
  264. package/index/emailDomain.d.ts +41 -16
  265. package/index/emailDomain.js +25 -0
  266. package/index/emailDomain.js.map +1 -1
  267. package/index/emailDomainVerification.d.ts +25 -3
  268. package/index/emailDomainVerification.js +22 -0
  269. package/index/emailDomainVerification.js.map +1 -1
  270. package/index/getDomain.d.ts +14 -11
  271. package/index/getDomain.js +8 -2
  272. package/index/getDomain.js.map +1 -1
  273. package/inline/hook.d.ts +89 -0
  274. package/inline/hook.js +35 -0
  275. package/inline/hook.js.map +1 -1
  276. package/linkDefinition.d.ts +30 -0
  277. package/linkDefinition.js +30 -0
  278. package/linkDefinition.js.map +1 -1
  279. package/linkValue.d.ts +59 -6
  280. package/linkValue.js +53 -0
  281. package/linkValue.js.map +1 -1
  282. package/network/zone.d.ts +74 -27
  283. package/network/zone.js +44 -0
  284. package/network/zone.js.map +1 -1
  285. package/orgConfiguration.d.ts +25 -0
  286. package/orgConfiguration.js +25 -0
  287. package/orgConfiguration.js.map +1 -1
  288. package/orgSupport.d.ts +20 -3
  289. package/orgSupport.js +17 -0
  290. package/orgSupport.js.map +1 -1
  291. package/package.json +1 -1
  292. package/policy/getDefaultPolicy.d.ts +7 -9
  293. package/policy/getDefaultPolicy.js +2 -6
  294. package/policy/getDefaultPolicy.js.map +1 -1
  295. package/policy/getPolicy.d.ts +10 -11
  296. package/policy/getPolicy.js +2 -2
  297. package/policy/getPolicy.js.map +1 -1
  298. package/policy/mfa.d.ts +259 -18
  299. package/policy/mfa.js +49 -0
  300. package/policy/mfa.js.map +1 -1
  301. package/policy/password.d.ts +117 -90
  302. package/policy/password.js +27 -0
  303. package/policy/password.js.map +1 -1
  304. package/policy/ruleIdpDiscovery.d.ts +149 -27
  305. package/policy/ruleIdpDiscovery.js +65 -0
  306. package/policy/ruleIdpDiscovery.js.map +1 -1
  307. package/policy/ruleMfa.d.ts +35 -24
  308. package/policy/ruleMfa.js +11 -0
  309. package/policy/ruleMfa.js.map +1 -1
  310. package/policy/rulePassword.d.ts +46 -33
  311. package/policy/rulePassword.js +13 -0
  312. package/policy/rulePassword.js.map +1 -1
  313. package/policy/ruleSignon.d.ts +170 -57
  314. package/policy/ruleSignon.js +92 -0
  315. package/policy/ruleSignon.js.map +1 -1
  316. package/policy/signon.d.ts +41 -15
  317. package/policy/signon.js +26 -0
  318. package/policy/signon.js.map +1 -1
  319. package/policyMfaDefault.d.ts +250 -13
  320. package/policyMfaDefault.js +45 -0
  321. package/policyMfaDefault.js.map +1 -1
  322. package/policyPasswordDefault.d.ts +88 -54
  323. package/policyPasswordDefault.js +22 -0
  324. package/policyPasswordDefault.js.map +1 -1
  325. package/policyProfileEnrollment.d.ts +28 -6
  326. package/policyProfileEnrollment.js +22 -0
  327. package/policyProfileEnrollment.js.map +1 -1
  328. package/policyProfileEnrollmentApps.d.ts +42 -5
  329. package/policyProfileEnrollmentApps.js +37 -0
  330. package/policyProfileEnrollmentApps.js.map +1 -1
  331. package/policyRuleProfileEnrollment.d.ts +88 -26
  332. package/policyRuleProfileEnrollment.js +62 -0
  333. package/policyRuleProfileEnrollment.js.map +1 -1
  334. package/profile/mapping.d.ts +95 -9
  335. package/profile/mapping.js +41 -0
  336. package/profile/mapping.js.map +1 -1
  337. package/rateLimiting.d.ts +43 -9
  338. package/rateLimiting.js +28 -0
  339. package/rateLimiting.js.map +1 -1
  340. package/resourceSet.d.ts +32 -10
  341. package/resourceSet.js +20 -1
  342. package/resourceSet.js.map +1 -1
  343. package/roleSubscription.d.ts +110 -9
  344. package/roleSubscription.js +26 -0
  345. package/roleSubscription.js.map +1 -1
  346. package/securityNotificationEmails.d.ts +45 -15
  347. package/securityNotificationEmails.js +30 -0
  348. package/securityNotificationEmails.js.map +1 -1
  349. package/templateSms.d.ts +47 -3
  350. package/templateSms.js +35 -0
  351. package/templateSms.js.map +1 -1
  352. package/theme.d.ts +59 -44
  353. package/theme.js +15 -0
  354. package/theme.js.map +1 -1
  355. package/threatInsightSettings.d.ts +58 -6
  356. package/threatInsightSettings.js +34 -0
  357. package/threatInsightSettings.js.map +1 -1
  358. package/trustedorigin/origin.d.ts +37 -12
  359. package/trustedorigin/origin.js +25 -0
  360. package/trustedorigin/origin.js.map +1 -1
  361. package/types/input.d.ts +227 -60
  362. package/types/output.d.ts +446 -56
  363. package/user/getUser.d.ts +104 -32
  364. package/user/getUser.js +2 -2
  365. package/user/getUser.js.map +1 -1
  366. package/user/getUserProfileMappingSource.d.ts +7 -9
  367. package/user/getUserProfileMappingSource.js +4 -6
  368. package/user/getUserProfileMappingSource.js.map +1 -1
  369. package/user/getUserType.d.ts +7 -7
  370. package/user/getUserType.js +2 -2
  371. package/user/getUsers.d.ts +57 -61
  372. package/user/getUsers.js +44 -30
  373. package/user/getUsers.js.map +1 -1
  374. package/user/user.d.ts +215 -117
  375. package/user/user.js +71 -0
  376. package/user/user.js.map +1 -1
  377. package/user/userType.d.ts +34 -9
  378. package/user/userType.js +25 -0
  379. package/user/userType.js.map +1 -1
  380. package/userAdminRoles.d.ts +41 -10
  381. package/userAdminRoles.js +29 -1
  382. package/userAdminRoles.js.map +1 -1
  383. package/userBaseSchemaProperty.d.ts +67 -24
  384. package/userBaseSchemaProperty.js +43 -0
  385. package/userBaseSchemaProperty.js.map +1 -1
  386. package/userFactorQuestion.d.ts +52 -14
  387. package/userFactorQuestion.js +39 -1
  388. package/userFactorQuestion.js.map +1 -1
  389. package/userGroupMemberships.d.ts +23 -4
  390. package/userGroupMemberships.js +20 -1
  391. package/userGroupMemberships.js.map +1 -1
  392. package/userSchemaProperty.d.ts +107 -57
  393. package/userSchemaProperty.js +32 -0
  394. package/userSchemaProperty.js.map +1 -1
  395. package/utilities.d.ts +4 -0
  396. package/utilities.js +33 -1
  397. package/utilities.js.map +1 -1
@@ -1,6 +1,44 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
- * Resource to manage a question factor for a user
3
+ * Creates security question factor for a user.
4
+ *
5
+ * This resource allows you to create and configure security question factor for a user.
6
+ *
7
+ * ## Example Usage
8
+ *
9
+ * ```typescript
10
+ * import * as pulumi from "@pulumi/pulumi";
11
+ * import * as okta from "@pulumi/okta";
12
+ *
13
+ * const exampleUser = new okta.user.User("exampleUser", {
14
+ * firstName: "John",
15
+ * lastName: "Smith",
16
+ * login: "john.smith@example.com",
17
+ * email: "john.smith@example.com",
18
+ * });
19
+ * const exampleUserSecurityQuestions = okta.getUserSecurityQuestionsOutput({
20
+ * userId: exampleUser.id,
21
+ * });
22
+ * const exampleFactor = new okta.factor.Factor("exampleFactor", {
23
+ * providerId: "okta_question",
24
+ * active: true,
25
+ * });
26
+ * const exampleUserFactorQuestion = new okta.UserFactorQuestion("exampleUserFactorQuestion", {
27
+ * userId: exampleUser.id,
28
+ * key: exampleUserSecurityQuestions.apply(exampleUserSecurityQuestions => exampleUserSecurityQuestions.questions?.[0]?.key),
29
+ * answer: "meatball",
30
+ * }, {
31
+ * dependsOn: [exampleFactor],
32
+ * });
33
+ * ```
34
+ *
35
+ * ## Import
36
+ *
37
+ * Security question factor for a user can be imported via the `user_id` and the `factor_id`.
38
+ *
39
+ * ```sh
40
+ * $ pulumi import okta:index/userFactorQuestion:UserFactorQuestion example <user id>/<question factor id>
41
+ * ```
4
42
  */
5
43
  export declare class UserFactorQuestion extends pulumi.CustomResource {
6
44
  /**
@@ -19,23 +57,23 @@ export declare class UserFactorQuestion extends pulumi.CustomResource {
19
57
  */
20
58
  static isInstance(obj: any): obj is UserFactorQuestion;
21
59
  /**
22
- * User password security answer
60
+ * Security question answer. Note here that answer won't be set during the resource import.
23
61
  */
24
62
  readonly answer: pulumi.Output<string>;
25
63
  /**
26
- * Unique key for question
64
+ * Security question unique key.
27
65
  */
28
66
  readonly key: pulumi.Output<string>;
29
67
  /**
30
- * User factor status.
68
+ * The status of the security question factor.
31
69
  */
32
70
  readonly status: pulumi.Output<string>;
33
71
  /**
34
- * Display text for question
72
+ * Display text for security question.
35
73
  */
36
74
  readonly text: pulumi.Output<string>;
37
75
  /**
38
- * ID of a Okta User
76
+ * ID of the user. Resource will be recreated when `userId` changes.
39
77
  */
40
78
  readonly userId: pulumi.Output<string>;
41
79
  /**
@@ -52,23 +90,23 @@ export declare class UserFactorQuestion extends pulumi.CustomResource {
52
90
  */
53
91
  export interface UserFactorQuestionState {
54
92
  /**
55
- * User password security answer
93
+ * Security question answer. Note here that answer won't be set during the resource import.
56
94
  */
57
95
  answer?: pulumi.Input<string>;
58
96
  /**
59
- * Unique key for question
97
+ * Security question unique key.
60
98
  */
61
99
  key?: pulumi.Input<string>;
62
100
  /**
63
- * User factor status.
101
+ * The status of the security question factor.
64
102
  */
65
103
  status?: pulumi.Input<string>;
66
104
  /**
67
- * Display text for question
105
+ * Display text for security question.
68
106
  */
69
107
  text?: pulumi.Input<string>;
70
108
  /**
71
- * ID of a Okta User
109
+ * ID of the user. Resource will be recreated when `userId` changes.
72
110
  */
73
111
  userId?: pulumi.Input<string>;
74
112
  }
@@ -77,15 +115,15 @@ export interface UserFactorQuestionState {
77
115
  */
78
116
  export interface UserFactorQuestionArgs {
79
117
  /**
80
- * User password security answer
118
+ * Security question answer. Note here that answer won't be set during the resource import.
81
119
  */
82
120
  answer: pulumi.Input<string>;
83
121
  /**
84
- * Unique key for question
122
+ * Security question unique key.
85
123
  */
86
124
  key: pulumi.Input<string>;
87
125
  /**
88
- * ID of a Okta User
126
+ * ID of the user. Resource will be recreated when `userId` changes.
89
127
  */
90
128
  userId: pulumi.Input<string>;
91
129
  }
@@ -6,7 +6,45 @@ exports.UserFactorQuestion = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Resource to manage a question factor for a user
9
+ * Creates security question factor for a user.
10
+ *
11
+ * This resource allows you to create and configure security question factor for a user.
12
+ *
13
+ * ## Example Usage
14
+ *
15
+ * ```typescript
16
+ * import * as pulumi from "@pulumi/pulumi";
17
+ * import * as okta from "@pulumi/okta";
18
+ *
19
+ * const exampleUser = new okta.user.User("exampleUser", {
20
+ * firstName: "John",
21
+ * lastName: "Smith",
22
+ * login: "john.smith@example.com",
23
+ * email: "john.smith@example.com",
24
+ * });
25
+ * const exampleUserSecurityQuestions = okta.getUserSecurityQuestionsOutput({
26
+ * userId: exampleUser.id,
27
+ * });
28
+ * const exampleFactor = new okta.factor.Factor("exampleFactor", {
29
+ * providerId: "okta_question",
30
+ * active: true,
31
+ * });
32
+ * const exampleUserFactorQuestion = new okta.UserFactorQuestion("exampleUserFactorQuestion", {
33
+ * userId: exampleUser.id,
34
+ * key: exampleUserSecurityQuestions.apply(exampleUserSecurityQuestions => exampleUserSecurityQuestions.questions?.[0]?.key),
35
+ * answer: "meatball",
36
+ * }, {
37
+ * dependsOn: [exampleFactor],
38
+ * });
39
+ * ```
40
+ *
41
+ * ## Import
42
+ *
43
+ * Security question factor for a user can be imported via the `user_id` and the `factor_id`.
44
+ *
45
+ * ```sh
46
+ * $ pulumi import okta:index/userFactorQuestion:UserFactorQuestion example &#60;user id&#62;/&#60;question factor id&#62;
47
+ * ```
10
48
  */
11
49
  class UserFactorQuestion extends pulumi.CustomResource {
12
50
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"userFactorQuestion.js","sourceRoot":"","sources":["../userFactorQuestion.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;GAEG;AACH,MAAa,kBAAmB,SAAQ,MAAM,CAAC,cAAc;IACzD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA+B,EAAE,IAAmC;QAC7H,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACzE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,kBAAkB,CAAC,YAAY,CAAC;IACnE,CAAC;IA+BD,YAAY,IAAY,EAAE,WAA8D,EAAE,IAAmC;QACzH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAkD,CAAC;YACjE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAiD,CAAC;YAC/D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACtD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACpD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC9C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACvE,CAAC;;AAxFL,gDAyFC;AA3EG,gBAAgB;AACO,+BAAY,GAAG,kDAAkD,CAAC"}
1
+ {"version":3,"file":"userFactorQuestion.js","sourceRoot":"","sources":["../userFactorQuestion.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAa,kBAAmB,SAAQ,MAAM,CAAC,cAAc;IACzD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA+B,EAAE,IAAmC;QAC7H,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACzE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,kBAAkB,CAAC,YAAY,CAAC;IACnE,CAAC;IA+BD,YAAY,IAAY,EAAE,WAA8D,EAAE,IAAmC;QACzH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAkD,CAAC;YACjE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAiD,CAAC;YAC/D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACtD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACpD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC9C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACvE,CAAC;;AAxFL,gDAyFC;AA3EG,gBAAgB;AACO,+BAAY,GAAG,kDAAkD,CAAC"}
@@ -1,6 +1,25 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  /**
3
- * Resource to manage a set of group memberships for a specific user.
3
+ * ## Example Usage
4
+ *
5
+ * ```typescript
6
+ * import * as pulumi from "@pulumi/pulumi";
7
+ * import * as okta from "@pulumi/okta";
8
+ *
9
+ * const testUser = new okta.user.User("testUser", {
10
+ * firstName: "TestAcc",
11
+ * lastName: "Smith",
12
+ * login: "testAcc-replace_with_uuid@example.com",
13
+ * email: "testAcc-replace_with_uuid@example.com",
14
+ * });
15
+ * const testUserGroupMemberships = new okta.UserGroupMemberships("testUserGroupMemberships", {
16
+ * userId: testUser.id,
17
+ * groups: [
18
+ * okta_group.test_1.id,
19
+ * okta_group.test_2.id,
20
+ * ],
21
+ * });
22
+ * ```
4
23
  */
5
24
  export declare class UserGroupMemberships extends pulumi.CustomResource {
6
25
  /**
@@ -23,7 +42,7 @@ export declare class UserGroupMemberships extends pulumi.CustomResource {
23
42
  */
24
43
  readonly groups: pulumi.Output<string[]>;
25
44
  /**
26
- * ID of a Okta User
45
+ * Okta user ID.
27
46
  */
28
47
  readonly userId: pulumi.Output<string>;
29
48
  /**
@@ -44,7 +63,7 @@ export interface UserGroupMembershipsState {
44
63
  */
45
64
  groups?: pulumi.Input<pulumi.Input<string>[]>;
46
65
  /**
47
- * ID of a Okta User
66
+ * Okta user ID.
48
67
  */
49
68
  userId?: pulumi.Input<string>;
50
69
  }
@@ -57,7 +76,7 @@ export interface UserGroupMembershipsArgs {
57
76
  */
58
77
  groups: pulumi.Input<pulumi.Input<string>[]>;
59
78
  /**
60
- * ID of a Okta User
79
+ * Okta user ID.
61
80
  */
62
81
  userId: pulumi.Input<string>;
63
82
  }
@@ -6,7 +6,26 @@ exports.UserGroupMemberships = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
- * Resource to manage a set of group memberships for a specific user.
9
+ * ## Example Usage
10
+ *
11
+ * ```typescript
12
+ * import * as pulumi from "@pulumi/pulumi";
13
+ * import * as okta from "@pulumi/okta";
14
+ *
15
+ * const testUser = new okta.user.User("testUser", {
16
+ * firstName: "TestAcc",
17
+ * lastName: "Smith",
18
+ * login: "testAcc-replace_with_uuid@example.com",
19
+ * email: "testAcc-replace_with_uuid@example.com",
20
+ * });
21
+ * const testUserGroupMemberships = new okta.UserGroupMemberships("testUserGroupMemberships", {
22
+ * userId: testUser.id,
23
+ * groups: [
24
+ * okta_group.test_1.id,
25
+ * okta_group.test_2.id,
26
+ * ],
27
+ * });
28
+ * ```
10
29
  */
11
30
  class UserGroupMemberships extends pulumi.CustomResource {
12
31
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"userGroupMemberships.js","sourceRoot":"","sources":["../userGroupMemberships.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;GAEG;AACH,MAAa,oBAAqB,SAAQ,MAAM,CAAC,cAAc;IAC3D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAiC,EAAE,IAAmC;QAC/H,OAAO,IAAI,oBAAoB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC3E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,oBAAoB,CAAC,YAAY,CAAC;IACrE,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAkE,EAAE,IAAmC;QAC7H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAoD,CAAC;YACnE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAmD,CAAC;YACjE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,oBAAoB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;;AAjEL,oDAkEC;AApDG,gBAAgB;AACO,iCAAY,GAAG,sDAAsD,CAAC"}
1
+ {"version":3,"file":"userGroupMemberships.js","sourceRoot":"","sources":["../userGroupMemberships.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,oBAAqB,SAAQ,MAAM,CAAC,cAAc;IAC3D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAiC,EAAE,IAAmC;QAC/H,OAAO,IAAI,oBAAoB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC3E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,oBAAoB,CAAC,YAAY,CAAC;IACrE,CAAC;IAmBD,YAAY,IAAY,EAAE,WAAkE,EAAE,IAAmC;QAC7H,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAoD,CAAC;YACnE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/D;aAAM;YACH,MAAM,IAAI,GAAG,WAAmD,CAAC;YACjE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACzD;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7D;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,oBAAoB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;;AAjEL,oDAkEC;AApDG,gBAAgB;AACO,iCAAY,GAAG,sDAAsD,CAAC"}
@@ -1,6 +1,38 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
+ /**
5
+ * ## Example Usage
6
+ *
7
+ * ```typescript
8
+ * import * as pulumi from "@pulumi/pulumi";
9
+ * import * as okta from "@pulumi/okta";
10
+ *
11
+ * const example = new okta.UserSchemaProperty("example", {
12
+ * description: "My custom property name",
13
+ * index: "customPropertyName",
14
+ * master: "OKTA",
15
+ * scope: "SELF",
16
+ * title: "customPropertyName",
17
+ * type: "string",
18
+ * userType: data.okta_user_type.example.id,
19
+ * });
20
+ * ```
21
+ *
22
+ * ## Import
23
+ *
24
+ * User schema property of default user type can be imported via the property variableName.
25
+ *
26
+ * ```sh
27
+ * $ pulumi import okta:index/userSchemaProperty:UserSchemaProperty example &#60;variableName&#62;
28
+ * ```
29
+ *
30
+ * User schema property of custom user type can be imported via user type id and property index
31
+ *
32
+ * ```sh
33
+ * $ pulumi import okta:index/userSchemaProperty:UserSchemaProperty example &#60;user type id&#62;.&#60;index&#62;
34
+ * ```
35
+ */
4
36
  export declare class UserSchemaProperty extends pulumi.CustomResource {
5
37
  /**
6
38
  * Get an existing UserSchemaProperty resource's state with the given name, ID, and optional extra
@@ -18,81 +50,87 @@ export declare class UserSchemaProperty extends pulumi.CustomResource {
18
50
  */
19
51
  static isInstance(obj: any): obj is UserSchemaProperty;
20
52
  /**
21
- * Custom Subschema enumerated value of a property of type array.
53
+ * Array of values that an array property's items can be set to.
22
54
  */
23
55
  readonly arrayEnums: pulumi.Output<string[] | undefined>;
24
56
  /**
25
- * array of valid JSON schemas for property type array.
57
+ * Display name and value an enum array can be set to.
26
58
  */
27
59
  readonly arrayOneOfs: pulumi.Output<outputs.UserSchemaPropertyArrayOneOf[] | undefined>;
28
60
  /**
29
- * Subschema array type: string, number, integer, reference. Type field must be an array.
61
+ * The type of the array elements if `type` is set to `"array"`.
30
62
  */
31
63
  readonly arrayType: pulumi.Output<string | undefined>;
32
64
  /**
33
- * Custom Subschema description
65
+ * The description of the user schema property.
34
66
  */
35
67
  readonly description: pulumi.Output<string | undefined>;
36
68
  /**
37
- * Custom Subschema enumerated value of the property. see: developer.okta.com/docs/api/resources/schemas#user-profile-schema-property-object
69
+ * Array of values a primitive property can be set to. See `arrayEnum` for arrays.
38
70
  */
39
71
  readonly enums: pulumi.Output<string[] | undefined>;
40
72
  /**
41
- * Subschema external name
73
+ * External name of the user schema property.
42
74
  */
43
75
  readonly externalName: pulumi.Output<string | undefined>;
44
76
  /**
45
- * Subschema external namespace
77
+ * External name of the user schema property.
46
78
  */
47
79
  readonly externalNamespace: pulumi.Output<string | undefined>;
48
80
  /**
49
- * Subschema unique string identifier
81
+ * The property name.
50
82
  */
51
83
  readonly index: pulumi.Output<string>;
52
84
  /**
53
- * SubSchema profile manager, if not set it will inherit its setting.
85
+ * Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.
54
86
  */
55
87
  readonly master: pulumi.Output<string | undefined>;
88
+ /**
89
+ * Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).
90
+ */
56
91
  readonly masterOverridePriorities: pulumi.Output<outputs.UserSchemaPropertyMasterOverridePriority[] | undefined>;
57
92
  /**
58
- * Subschema of type string maximum length
93
+ * The maximum length of the user property value. Only applies to type `"string"`.
59
94
  */
60
95
  readonly maxLength: pulumi.Output<number | undefined>;
61
96
  /**
62
- * Subschema of type string minimum length
97
+ * The minimum length of the user property value. Only applies to type `"string"`.
63
98
  */
64
99
  readonly minLength: pulumi.Output<number | undefined>;
65
100
  /**
66
- * Custom Subschema json schemas. see: developer.okta.com/docs/api/resources/schemas#user-profile-schema-property-object
101
+ * Array of maps containing a mapping for display name to enum value.
67
102
  */
68
103
  readonly oneOfs: pulumi.Output<outputs.UserSchemaPropertyOneOf[] | undefined>;
69
104
  /**
70
- * The validation pattern to use for the subschema. Must be in form of '.+', or '[\n\n]+' if present.'
105
+ * The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
71
106
  */
72
107
  readonly pattern: pulumi.Output<string | undefined>;
73
108
  /**
74
- * SubSchema permissions: HIDE, READ*ONLY, or READ*WRITE.
109
+ * Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
75
110
  */
76
111
  readonly permissions: pulumi.Output<string | undefined>;
77
112
  /**
78
- * Whether the subschema is required
113
+ * Whether the property is required for these users.
79
114
  */
80
115
  readonly required: pulumi.Output<boolean | undefined>;
116
+ /**
117
+ * determines whether an app user attribute can be set at the Individual or Group Level.
118
+ */
81
119
  readonly scope: pulumi.Output<string | undefined>;
82
120
  /**
83
- * Enum title
121
+ * display name for the enum value.
84
122
  */
85
123
  readonly title: pulumi.Output<string>;
86
124
  /**
87
- * Subschema type: string, boolean, number, integer, array, or object
125
+ * Type of profile source.
88
126
  */
89
127
  readonly type: pulumi.Output<string>;
90
128
  /**
91
- * Subschema unique restriction
129
+ * Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.
92
130
  */
93
131
  readonly unique: pulumi.Output<string | undefined>;
94
132
  /**
95
- * Custom subschema user type
133
+ * User type ID
96
134
  */
97
135
  readonly userType: pulumi.Output<string | undefined>;
98
136
  /**
@@ -109,81 +147,87 @@ export declare class UserSchemaProperty extends pulumi.CustomResource {
109
147
  */
110
148
  export interface UserSchemaPropertyState {
111
149
  /**
112
- * Custom Subschema enumerated value of a property of type array.
150
+ * Array of values that an array property's items can be set to.
113
151
  */
114
152
  arrayEnums?: pulumi.Input<pulumi.Input<string>[]>;
115
153
  /**
116
- * array of valid JSON schemas for property type array.
154
+ * Display name and value an enum array can be set to.
117
155
  */
118
156
  arrayOneOfs?: pulumi.Input<pulumi.Input<inputs.UserSchemaPropertyArrayOneOf>[]>;
119
157
  /**
120
- * Subschema array type: string, number, integer, reference. Type field must be an array.
158
+ * The type of the array elements if `type` is set to `"array"`.
121
159
  */
122
160
  arrayType?: pulumi.Input<string>;
123
161
  /**
124
- * Custom Subschema description
162
+ * The description of the user schema property.
125
163
  */
126
164
  description?: pulumi.Input<string>;
127
165
  /**
128
- * Custom Subschema enumerated value of the property. see: developer.okta.com/docs/api/resources/schemas#user-profile-schema-property-object
166
+ * Array of values a primitive property can be set to. See `arrayEnum` for arrays.
129
167
  */
130
168
  enums?: pulumi.Input<pulumi.Input<string>[]>;
131
169
  /**
132
- * Subschema external name
170
+ * External name of the user schema property.
133
171
  */
134
172
  externalName?: pulumi.Input<string>;
135
173
  /**
136
- * Subschema external namespace
174
+ * External name of the user schema property.
137
175
  */
138
176
  externalNamespace?: pulumi.Input<string>;
139
177
  /**
140
- * Subschema unique string identifier
178
+ * The property name.
141
179
  */
142
180
  index?: pulumi.Input<string>;
143
181
  /**
144
- * SubSchema profile manager, if not set it will inherit its setting.
182
+ * Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.
145
183
  */
146
184
  master?: pulumi.Input<string>;
185
+ /**
186
+ * Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).
187
+ */
147
188
  masterOverridePriorities?: pulumi.Input<pulumi.Input<inputs.UserSchemaPropertyMasterOverridePriority>[]>;
148
189
  /**
149
- * Subschema of type string maximum length
190
+ * The maximum length of the user property value. Only applies to type `"string"`.
150
191
  */
151
192
  maxLength?: pulumi.Input<number>;
152
193
  /**
153
- * Subschema of type string minimum length
194
+ * The minimum length of the user property value. Only applies to type `"string"`.
154
195
  */
155
196
  minLength?: pulumi.Input<number>;
156
197
  /**
157
- * Custom Subschema json schemas. see: developer.okta.com/docs/api/resources/schemas#user-profile-schema-property-object
198
+ * Array of maps containing a mapping for display name to enum value.
158
199
  */
159
200
  oneOfs?: pulumi.Input<pulumi.Input<inputs.UserSchemaPropertyOneOf>[]>;
160
201
  /**
161
- * The validation pattern to use for the subschema. Must be in form of '.+', or '[\n\n]+' if present.'
202
+ * The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
162
203
  */
163
204
  pattern?: pulumi.Input<string>;
164
205
  /**
165
- * SubSchema permissions: HIDE, READ*ONLY, or READ*WRITE.
206
+ * Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
166
207
  */
167
208
  permissions?: pulumi.Input<string>;
168
209
  /**
169
- * Whether the subschema is required
210
+ * Whether the property is required for these users.
170
211
  */
171
212
  required?: pulumi.Input<boolean>;
213
+ /**
214
+ * determines whether an app user attribute can be set at the Individual or Group Level.
215
+ */
172
216
  scope?: pulumi.Input<string>;
173
217
  /**
174
- * Enum title
218
+ * display name for the enum value.
175
219
  */
176
220
  title?: pulumi.Input<string>;
177
221
  /**
178
- * Subschema type: string, boolean, number, integer, array, or object
222
+ * Type of profile source.
179
223
  */
180
224
  type?: pulumi.Input<string>;
181
225
  /**
182
- * Subschema unique restriction
226
+ * Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.
183
227
  */
184
228
  unique?: pulumi.Input<string>;
185
229
  /**
186
- * Custom subschema user type
230
+ * User type ID
187
231
  */
188
232
  userType?: pulumi.Input<string>;
189
233
  }
@@ -192,81 +236,87 @@ export interface UserSchemaPropertyState {
192
236
  */
193
237
  export interface UserSchemaPropertyArgs {
194
238
  /**
195
- * Custom Subschema enumerated value of a property of type array.
239
+ * Array of values that an array property's items can be set to.
196
240
  */
197
241
  arrayEnums?: pulumi.Input<pulumi.Input<string>[]>;
198
242
  /**
199
- * array of valid JSON schemas for property type array.
243
+ * Display name and value an enum array can be set to.
200
244
  */
201
245
  arrayOneOfs?: pulumi.Input<pulumi.Input<inputs.UserSchemaPropertyArrayOneOf>[]>;
202
246
  /**
203
- * Subschema array type: string, number, integer, reference. Type field must be an array.
247
+ * The type of the array elements if `type` is set to `"array"`.
204
248
  */
205
249
  arrayType?: pulumi.Input<string>;
206
250
  /**
207
- * Custom Subschema description
251
+ * The description of the user schema property.
208
252
  */
209
253
  description?: pulumi.Input<string>;
210
254
  /**
211
- * Custom Subschema enumerated value of the property. see: developer.okta.com/docs/api/resources/schemas#user-profile-schema-property-object
255
+ * Array of values a primitive property can be set to. See `arrayEnum` for arrays.
212
256
  */
213
257
  enums?: pulumi.Input<pulumi.Input<string>[]>;
214
258
  /**
215
- * Subschema external name
259
+ * External name of the user schema property.
216
260
  */
217
261
  externalName?: pulumi.Input<string>;
218
262
  /**
219
- * Subschema external namespace
263
+ * External name of the user schema property.
220
264
  */
221
265
  externalNamespace?: pulumi.Input<string>;
222
266
  /**
223
- * Subschema unique string identifier
267
+ * The property name.
224
268
  */
225
269
  index: pulumi.Input<string>;
226
270
  /**
227
- * SubSchema profile manager, if not set it will inherit its setting.
271
+ * Master priority for the user schema property. It can be set to `"PROFILE_MASTER"`, `"OVERRIDE"` or `"OKTA"`.
228
272
  */
229
273
  master?: pulumi.Input<string>;
274
+ /**
275
+ * Prioritized list of profile sources (required when `master` is `"OVERRIDE"`).
276
+ */
230
277
  masterOverridePriorities?: pulumi.Input<pulumi.Input<inputs.UserSchemaPropertyMasterOverridePriority>[]>;
231
278
  /**
232
- * Subschema of type string maximum length
279
+ * The maximum length of the user property value. Only applies to type `"string"`.
233
280
  */
234
281
  maxLength?: pulumi.Input<number>;
235
282
  /**
236
- * Subschema of type string minimum length
283
+ * The minimum length of the user property value. Only applies to type `"string"`.
237
284
  */
238
285
  minLength?: pulumi.Input<number>;
239
286
  /**
240
- * Custom Subschema json schemas. see: developer.okta.com/docs/api/resources/schemas#user-profile-schema-property-object
287
+ * Array of maps containing a mapping for display name to enum value.
241
288
  */
242
289
  oneOfs?: pulumi.Input<pulumi.Input<inputs.UserSchemaPropertyOneOf>[]>;
243
290
  /**
244
- * The validation pattern to use for the subschema. Must be in form of '.+', or '[\n\n]+' if present.'
291
+ * The validation pattern to use for the subschema. Must be in form of '.+', or '[<pattern>]+' if present.'
245
292
  */
246
293
  pattern?: pulumi.Input<string>;
247
294
  /**
248
- * SubSchema permissions: HIDE, READ*ONLY, or READ*WRITE.
295
+ * Access control permissions for the property. It can be set to `"READ_WRITE"`, `"READ_ONLY"`, `"HIDE"`.
249
296
  */
250
297
  permissions?: pulumi.Input<string>;
251
298
  /**
252
- * Whether the subschema is required
299
+ * Whether the property is required for these users.
253
300
  */
254
301
  required?: pulumi.Input<boolean>;
302
+ /**
303
+ * determines whether an app user attribute can be set at the Individual or Group Level.
304
+ */
255
305
  scope?: pulumi.Input<string>;
256
306
  /**
257
- * Enum title
307
+ * display name for the enum value.
258
308
  */
259
309
  title: pulumi.Input<string>;
260
310
  /**
261
- * Subschema type: string, boolean, number, integer, array, or object
311
+ * Type of profile source.
262
312
  */
263
313
  type: pulumi.Input<string>;
264
314
  /**
265
- * Subschema unique restriction
315
+ * Whether the property should be unique. It can be set to `"UNIQUE_VALIDATED"` or `"NOT_UNIQUE"`.
266
316
  */
267
317
  unique?: pulumi.Input<string>;
268
318
  /**
269
- * Custom subschema user type
319
+ * User type ID
270
320
  */
271
321
  userType?: pulumi.Input<string>;
272
322
  }