@aws-sdk/client-wickr 3.956.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 (227) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +541 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  4. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  5. package/dist-cjs/endpoint/ruleset.js +7 -0
  6. package/dist-cjs/index.js +2520 -0
  7. package/dist-cjs/runtimeConfig.browser.js +39 -0
  8. package/dist-cjs/runtimeConfig.js +55 -0
  9. package/dist-cjs/runtimeConfig.native.js +15 -0
  10. package/dist-cjs/runtimeConfig.shared.js +41 -0
  11. package/dist-es/Wickr.js +91 -0
  12. package/dist-es/WickrClient.js +50 -0
  13. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  14. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  15. package/dist-es/commands/BatchCreateUserCommand.js +16 -0
  16. package/dist-es/commands/BatchDeleteUserCommand.js +16 -0
  17. package/dist-es/commands/BatchLookupUserUnameCommand.js +16 -0
  18. package/dist-es/commands/BatchReinviteUserCommand.js +16 -0
  19. package/dist-es/commands/BatchResetDevicesForUserCommand.js +16 -0
  20. package/dist-es/commands/BatchToggleUserSuspendStatusCommand.js +16 -0
  21. package/dist-es/commands/CreateBotCommand.js +16 -0
  22. package/dist-es/commands/CreateDataRetentionBotChallengeCommand.js +16 -0
  23. package/dist-es/commands/CreateDataRetentionBotCommand.js +16 -0
  24. package/dist-es/commands/CreateNetworkCommand.js +16 -0
  25. package/dist-es/commands/CreateSecurityGroupCommand.js +16 -0
  26. package/dist-es/commands/DeleteBotCommand.js +16 -0
  27. package/dist-es/commands/DeleteDataRetentionBotCommand.js +16 -0
  28. package/dist-es/commands/DeleteNetworkCommand.js +16 -0
  29. package/dist-es/commands/DeleteSecurityGroupCommand.js +16 -0
  30. package/dist-es/commands/GetBotCommand.js +16 -0
  31. package/dist-es/commands/GetBotsCountCommand.js +16 -0
  32. package/dist-es/commands/GetDataRetentionBotCommand.js +16 -0
  33. package/dist-es/commands/GetGuestUserHistoryCountCommand.js +16 -0
  34. package/dist-es/commands/GetNetworkCommand.js +16 -0
  35. package/dist-es/commands/GetNetworkSettingsCommand.js +16 -0
  36. package/dist-es/commands/GetOidcInfoCommand.js +16 -0
  37. package/dist-es/commands/GetSecurityGroupCommand.js +16 -0
  38. package/dist-es/commands/GetUserCommand.js +16 -0
  39. package/dist-es/commands/GetUsersCountCommand.js +16 -0
  40. package/dist-es/commands/ListBlockedGuestUsersCommand.js +16 -0
  41. package/dist-es/commands/ListBotsCommand.js +16 -0
  42. package/dist-es/commands/ListDevicesForUserCommand.js +16 -0
  43. package/dist-es/commands/ListGuestUsersCommand.js +16 -0
  44. package/dist-es/commands/ListNetworksCommand.js +16 -0
  45. package/dist-es/commands/ListSecurityGroupUsersCommand.js +16 -0
  46. package/dist-es/commands/ListSecurityGroupsCommand.js +16 -0
  47. package/dist-es/commands/ListUsersCommand.js +16 -0
  48. package/dist-es/commands/RegisterOidcConfigCommand.js +16 -0
  49. package/dist-es/commands/RegisterOidcConfigTestCommand.js +16 -0
  50. package/dist-es/commands/UpdateBotCommand.js +16 -0
  51. package/dist-es/commands/UpdateDataRetentionCommand.js +16 -0
  52. package/dist-es/commands/UpdateGuestUserCommand.js +16 -0
  53. package/dist-es/commands/UpdateNetworkCommand.js +16 -0
  54. package/dist-es/commands/UpdateNetworkSettingsCommand.js +16 -0
  55. package/dist-es/commands/UpdateSecurityGroupCommand.js +16 -0
  56. package/dist-es/commands/UpdateUserCommand.js +16 -0
  57. package/dist-es/commands/index.js +42 -0
  58. package/dist-es/endpoint/EndpointParameters.js +13 -0
  59. package/dist-es/endpoint/endpointResolver.js +14 -0
  60. package/dist-es/endpoint/ruleset.js +4 -0
  61. package/dist-es/extensionConfiguration.js +1 -0
  62. package/dist-es/index.js +9 -0
  63. package/dist-es/models/WickrServiceException.js +8 -0
  64. package/dist-es/models/enums.js +28 -0
  65. package/dist-es/models/errors.js +87 -0
  66. package/dist-es/models/models_0.js +1 -0
  67. package/dist-es/pagination/Interfaces.js +1 -0
  68. package/dist-es/pagination/ListBlockedGuestUsersPaginator.js +4 -0
  69. package/dist-es/pagination/ListBotsPaginator.js +4 -0
  70. package/dist-es/pagination/ListDevicesForUserPaginator.js +4 -0
  71. package/dist-es/pagination/ListGuestUsersPaginator.js +4 -0
  72. package/dist-es/pagination/ListNetworksPaginator.js +4 -0
  73. package/dist-es/pagination/ListSecurityGroupUsersPaginator.js +4 -0
  74. package/dist-es/pagination/ListSecurityGroupsPaginator.js +4 -0
  75. package/dist-es/pagination/ListUsersPaginator.js +4 -0
  76. package/dist-es/pagination/index.js +9 -0
  77. package/dist-es/runtimeConfig.browser.js +34 -0
  78. package/dist-es/runtimeConfig.js +50 -0
  79. package/dist-es/runtimeConfig.native.js +11 -0
  80. package/dist-es/runtimeConfig.shared.js +37 -0
  81. package/dist-es/runtimeExtensions.js +9 -0
  82. package/dist-es/schemas/schemas_0.js +1491 -0
  83. package/dist-types/Wickr.d.ts +305 -0
  84. package/dist-types/WickrClient.d.ts +229 -0
  85. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  86. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  87. package/dist-types/commands/BatchCreateUserCommand.d.ts +251 -0
  88. package/dist-types/commands/BatchDeleteUserCommand.d.ts +171 -0
  89. package/dist-types/commands/BatchLookupUserUnameCommand.d.ts +175 -0
  90. package/dist-types/commands/BatchReinviteUserCommand.d.ts +191 -0
  91. package/dist-types/commands/BatchResetDevicesForUserCommand.d.ts +190 -0
  92. package/dist-types/commands/BatchToggleUserSuspendStatusCommand.d.ts +174 -0
  93. package/dist-types/commands/CreateBotCommand.d.ts +161 -0
  94. package/dist-types/commands/CreateDataRetentionBotChallengeCommand.d.ts +110 -0
  95. package/dist-types/commands/CreateDataRetentionBotCommand.d.ts +123 -0
  96. package/dist-types/commands/CreateNetworkCommand.d.ts +150 -0
  97. package/dist-types/commands/CreateSecurityGroupCommand.d.ts +241 -0
  98. package/dist-types/commands/DeleteBotCommand.d.ts +126 -0
  99. package/dist-types/commands/DeleteDataRetentionBotCommand.d.ts +110 -0
  100. package/dist-types/commands/DeleteNetworkCommand.d.ts +124 -0
  101. package/dist-types/commands/DeleteSecurityGroupCommand.d.ts +130 -0
  102. package/dist-types/commands/GetBotCommand.d.ts +144 -0
  103. package/dist-types/commands/GetBotsCountCommand.d.ts +131 -0
  104. package/dist-types/commands/GetDataRetentionBotCommand.d.ts +140 -0
  105. package/dist-types/commands/GetGuestUserHistoryCountCommand.d.ts +155 -0
  106. package/dist-types/commands/GetNetworkCommand.d.ts +137 -0
  107. package/dist-types/commands/GetNetworkSettingsCommand.d.ts +166 -0
  108. package/dist-types/commands/GetOidcInfoCommand.d.ts +169 -0
  109. package/dist-types/commands/GetSecurityGroupCommand.d.ts +211 -0
  110. package/dist-types/commands/GetUserCommand.d.ts +194 -0
  111. package/dist-types/commands/GetUsersCountCommand.d.ts +137 -0
  112. package/dist-types/commands/ListBlockedGuestUsersCommand.d.ts +185 -0
  113. package/dist-types/commands/ListBotsCommand.d.ts +192 -0
  114. package/dist-types/commands/ListDevicesForUserCommand.d.ts +197 -0
  115. package/dist-types/commands/ListGuestUsersCommand.d.ts +192 -0
  116. package/dist-types/commands/ListNetworksCommand.d.ts +167 -0
  117. package/dist-types/commands/ListSecurityGroupUsersCommand.d.ts +156 -0
  118. package/dist-types/commands/ListSecurityGroupsCommand.d.ts +246 -0
  119. package/dist-types/commands/ListUsersCommand.d.ts +221 -0
  120. package/dist-types/commands/RegisterOidcConfigCommand.d.ts +174 -0
  121. package/dist-types/commands/RegisterOidcConfigTestCommand.d.ts +168 -0
  122. package/dist-types/commands/UpdateBotCommand.d.ts +133 -0
  123. package/dist-types/commands/UpdateDataRetentionCommand.d.ts +144 -0
  124. package/dist-types/commands/UpdateGuestUserCommand.d.ts +146 -0
  125. package/dist-types/commands/UpdateNetworkCommand.d.ts +142 -0
  126. package/dist-types/commands/UpdateNetworkSettingsCommand.d.ts +234 -0
  127. package/dist-types/commands/UpdateSecurityGroupCommand.d.ts +282 -0
  128. package/dist-types/commands/UpdateUserCommand.d.ts +229 -0
  129. package/dist-types/commands/index.d.ts +42 -0
  130. package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
  131. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  132. package/dist-types/endpoint/ruleset.d.ts +2 -0
  133. package/dist-types/extensionConfiguration.d.ts +9 -0
  134. package/dist-types/index.d.ts +17 -0
  135. package/dist-types/models/WickrServiceException.d.ts +14 -0
  136. package/dist-types/models/enums.d.ts +58 -0
  137. package/dist-types/models/errors.d.ts +92 -0
  138. package/dist-types/models/models_0.d.ts +2975 -0
  139. package/dist-types/pagination/Interfaces.d.ts +8 -0
  140. package/dist-types/pagination/ListBlockedGuestUsersPaginator.d.ts +7 -0
  141. package/dist-types/pagination/ListBotsPaginator.d.ts +7 -0
  142. package/dist-types/pagination/ListDevicesForUserPaginator.d.ts +7 -0
  143. package/dist-types/pagination/ListGuestUsersPaginator.d.ts +7 -0
  144. package/dist-types/pagination/ListNetworksPaginator.d.ts +7 -0
  145. package/dist-types/pagination/ListSecurityGroupUsersPaginator.d.ts +7 -0
  146. package/dist-types/pagination/ListSecurityGroupsPaginator.d.ts +7 -0
  147. package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
  148. package/dist-types/pagination/index.d.ts +9 -0
  149. package/dist-types/runtimeConfig.browser.d.ts +55 -0
  150. package/dist-types/runtimeConfig.d.ts +55 -0
  151. package/dist-types/runtimeConfig.native.d.ts +54 -0
  152. package/dist-types/runtimeConfig.shared.d.ts +27 -0
  153. package/dist-types/runtimeExtensions.d.ts +17 -0
  154. package/dist-types/schemas/schemas_0.d.ts +164 -0
  155. package/dist-types/ts3.4/Wickr.d.ts +720 -0
  156. package/dist-types/ts3.4/WickrClient.d.ts +371 -0
  157. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  158. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  159. package/dist-types/ts3.4/commands/BatchCreateUserCommand.d.ts +50 -0
  160. package/dist-types/ts3.4/commands/BatchDeleteUserCommand.d.ts +50 -0
  161. package/dist-types/ts3.4/commands/BatchLookupUserUnameCommand.d.ts +51 -0
  162. package/dist-types/ts3.4/commands/BatchReinviteUserCommand.d.ts +51 -0
  163. package/dist-types/ts3.4/commands/BatchResetDevicesForUserCommand.d.ts +51 -0
  164. package/dist-types/ts3.4/commands/BatchToggleUserSuspendStatusCommand.d.ts +51 -0
  165. package/dist-types/ts3.4/commands/CreateBotCommand.d.ts +47 -0
  166. package/dist-types/ts3.4/commands/CreateDataRetentionBotChallengeCommand.d.ts +51 -0
  167. package/dist-types/ts3.4/commands/CreateDataRetentionBotCommand.d.ts +51 -0
  168. package/dist-types/ts3.4/commands/CreateNetworkCommand.d.ts +50 -0
  169. package/dist-types/ts3.4/commands/CreateSecurityGroupCommand.d.ts +51 -0
  170. package/dist-types/ts3.4/commands/DeleteBotCommand.d.ts +47 -0
  171. package/dist-types/ts3.4/commands/DeleteDataRetentionBotCommand.d.ts +51 -0
  172. package/dist-types/ts3.4/commands/DeleteNetworkCommand.d.ts +50 -0
  173. package/dist-types/ts3.4/commands/DeleteSecurityGroupCommand.d.ts +51 -0
  174. package/dist-types/ts3.4/commands/GetBotCommand.d.ts +41 -0
  175. package/dist-types/ts3.4/commands/GetBotsCountCommand.d.ts +47 -0
  176. package/dist-types/ts3.4/commands/GetDataRetentionBotCommand.d.ts +51 -0
  177. package/dist-types/ts3.4/commands/GetGuestUserHistoryCountCommand.d.ts +51 -0
  178. package/dist-types/ts3.4/commands/GetNetworkCommand.d.ts +47 -0
  179. package/dist-types/ts3.4/commands/GetNetworkSettingsCommand.d.ts +51 -0
  180. package/dist-types/ts3.4/commands/GetOidcInfoCommand.d.ts +47 -0
  181. package/dist-types/ts3.4/commands/GetSecurityGroupCommand.d.ts +50 -0
  182. package/dist-types/ts3.4/commands/GetUserCommand.d.ts +43 -0
  183. package/dist-types/ts3.4/commands/GetUsersCountCommand.d.ts +50 -0
  184. package/dist-types/ts3.4/commands/ListBlockedGuestUsersCommand.d.ts +51 -0
  185. package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +47 -0
  186. package/dist-types/ts3.4/commands/ListDevicesForUserCommand.d.ts +51 -0
  187. package/dist-types/ts3.4/commands/ListGuestUsersCommand.d.ts +50 -0
  188. package/dist-types/ts3.4/commands/ListNetworksCommand.d.ts +47 -0
  189. package/dist-types/ts3.4/commands/ListSecurityGroupUsersCommand.d.ts +51 -0
  190. package/dist-types/ts3.4/commands/ListSecurityGroupsCommand.d.ts +51 -0
  191. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +47 -0
  192. package/dist-types/ts3.4/commands/RegisterOidcConfigCommand.d.ts +51 -0
  193. package/dist-types/ts3.4/commands/RegisterOidcConfigTestCommand.d.ts +51 -0
  194. package/dist-types/ts3.4/commands/UpdateBotCommand.d.ts +47 -0
  195. package/dist-types/ts3.4/commands/UpdateDataRetentionCommand.d.ts +51 -0
  196. package/dist-types/ts3.4/commands/UpdateGuestUserCommand.d.ts +50 -0
  197. package/dist-types/ts3.4/commands/UpdateNetworkCommand.d.ts +50 -0
  198. package/dist-types/ts3.4/commands/UpdateNetworkSettingsCommand.d.ts +51 -0
  199. package/dist-types/ts3.4/commands/UpdateSecurityGroupCommand.d.ts +51 -0
  200. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +47 -0
  201. package/dist-types/ts3.4/commands/index.d.ts +42 -0
  202. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  203. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  204. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  205. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  206. package/dist-types/ts3.4/index.d.ts +12 -0
  207. package/dist-types/ts3.4/models/WickrServiceException.d.ts +9 -0
  208. package/dist-types/ts3.4/models/enums.d.ts +31 -0
  209. package/dist-types/ts3.4/models/errors.d.ts +43 -0
  210. package/dist-types/ts3.4/models/models_0.d.ts +714 -0
  211. package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
  212. package/dist-types/ts3.4/pagination/ListBlockedGuestUsersPaginator.d.ts +11 -0
  213. package/dist-types/ts3.4/pagination/ListBotsPaginator.d.ts +11 -0
  214. package/dist-types/ts3.4/pagination/ListDevicesForUserPaginator.d.ts +11 -0
  215. package/dist-types/ts3.4/pagination/ListGuestUsersPaginator.d.ts +11 -0
  216. package/dist-types/ts3.4/pagination/ListNetworksPaginator.d.ts +11 -0
  217. package/dist-types/ts3.4/pagination/ListSecurityGroupUsersPaginator.d.ts +11 -0
  218. package/dist-types/ts3.4/pagination/ListSecurityGroupsPaginator.d.ts +11 -0
  219. package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
  220. package/dist-types/ts3.4/pagination/index.d.ts +9 -0
  221. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
  222. package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
  223. package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
  224. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
  225. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  226. package/dist-types/ts3.4/schemas/schemas_0.d.ts +168 -0
  227. package/package.json +100 -0
@@ -0,0 +1,2975 @@
1
+ import { AccessLevel, BotStatus, DataRetentionActionType, SortDirection, Status, UserStatus } from "./enums";
2
+ /**
3
+ * <p>Represents a device where a user has logged into Wickr, containing information about the device's type, status, and login history.</p>
4
+ * @public
5
+ */
6
+ export interface BasicDeviceObject {
7
+ /**
8
+ * <p>The unique application ID for the Wickr app on this device.</p>
9
+ * @public
10
+ */
11
+ appId?: string | undefined;
12
+ /**
13
+ * <p>The timestamp when the device first appeared in the Wickr database.</p>
14
+ * @public
15
+ */
16
+ created?: string | undefined;
17
+ /**
18
+ * <p>The timestamp when the device last successfully logged into Wickr. This is also used to determine SSO idle time.</p>
19
+ * @public
20
+ */
21
+ lastLogin?: string | undefined;
22
+ /**
23
+ * <p>The current status of the device, either 'Active' or 'Reset' depending on whether the device is currently active or has been marked for reset.</p>
24
+ * @public
25
+ */
26
+ statusText?: string | undefined;
27
+ /**
28
+ * <p>Indicates whether the device is suspended.</p>
29
+ * @public
30
+ */
31
+ suspend?: boolean | undefined;
32
+ /**
33
+ * <p>The operating system of the device (e.g., 'MacOSX', 'Windows', 'iOS', 'Android').</p>
34
+ * @public
35
+ */
36
+ type?: string | undefined;
37
+ }
38
+ /**
39
+ * <p>Contains the details for a single user to be created in a batch user creation request.</p> <note> <p>A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.</p> </note> <note> <p> <code>codeValidation</code>, <code>inviteCode</code>, and <code>inviteCodeTtl</code> are restricted to networks under preview only.</p> </note>
40
+ * @public
41
+ */
42
+ export interface BatchCreateUserRequestItem {
43
+ /**
44
+ * <p>The first name of the user.</p>
45
+ * @public
46
+ */
47
+ firstName?: string | undefined;
48
+ /**
49
+ * <p>The last name of the user.</p>
50
+ * @public
51
+ */
52
+ lastName?: string | undefined;
53
+ /**
54
+ * <p>A list of security group IDs to which the user should be assigned.</p>
55
+ * @public
56
+ */
57
+ securityGroupIds: string[] | undefined;
58
+ /**
59
+ * <p>The email address or username for the user. Must be unique within the network.</p>
60
+ * @public
61
+ */
62
+ username: string | undefined;
63
+ /**
64
+ * <p>A custom invite code for the user. If not provided, one will be generated automatically.</p>
65
+ * @public
66
+ */
67
+ inviteCode?: string | undefined;
68
+ /**
69
+ * <p>The time-to-live for the invite code in days. After this period, the invite code will expire.</p>
70
+ * @public
71
+ */
72
+ inviteCodeTtl?: number | undefined;
73
+ /**
74
+ * <p>Indicates whether the user can be verified through a custom invite code.</p>
75
+ * @public
76
+ */
77
+ codeValidation?: boolean | undefined;
78
+ }
79
+ /**
80
+ * @public
81
+ */
82
+ export interface BatchCreateUserRequest {
83
+ /**
84
+ * <p>The ID of the Wickr network where users will be created.</p>
85
+ * @public
86
+ */
87
+ networkId: string | undefined;
88
+ /**
89
+ * <p>A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.</p>
90
+ * @public
91
+ */
92
+ users: BatchCreateUserRequestItem[] | undefined;
93
+ /**
94
+ * <p>A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.</p>
95
+ * @public
96
+ */
97
+ clientToken?: string | undefined;
98
+ }
99
+ /**
100
+ * <p>Contains error information for a user operation that failed in a batch user request.</p>
101
+ * @public
102
+ */
103
+ export interface BatchUserErrorResponseItem {
104
+ /**
105
+ * <p>The field that caused the error.</p>
106
+ * @public
107
+ */
108
+ field?: string | undefined;
109
+ /**
110
+ * <p>A description of why the user operation failed.</p>
111
+ * @public
112
+ */
113
+ reason?: string | undefined;
114
+ /**
115
+ * <p>The user ID associated with the failed operation.</p>
116
+ * @public
117
+ */
118
+ userId: string | undefined;
119
+ }
120
+ /**
121
+ * <p>Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.</p> <note> <p>codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.</p> </note>
122
+ * @public
123
+ */
124
+ export interface User {
125
+ /**
126
+ * <p>The unique identifier for the user within the network.</p>
127
+ * @public
128
+ */
129
+ userId?: string | undefined;
130
+ /**
131
+ * <p>The first name of the user.</p>
132
+ * @public
133
+ */
134
+ firstName?: string | undefined;
135
+ /**
136
+ * <p>The last name of the user.</p>
137
+ * @public
138
+ */
139
+ lastName?: string | undefined;
140
+ /**
141
+ * <p>The email address or username of the user. For bots, this must end in 'bot'.</p>
142
+ * @public
143
+ */
144
+ username?: string | undefined;
145
+ /**
146
+ * <p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</p>
147
+ * @public
148
+ */
149
+ securityGroups?: string[] | undefined;
150
+ /**
151
+ * <p>Indicates whether the user has administrator privileges in the network.</p>
152
+ * @public
153
+ */
154
+ isAdmin?: boolean | undefined;
155
+ /**
156
+ * <p>Indicates whether the user is currently suspended and unable to access the network.</p>
157
+ * @public
158
+ */
159
+ suspended?: boolean | undefined;
160
+ /**
161
+ * <p>The current status of the user (1 for pending invitation, 2 for active).</p>
162
+ * @public
163
+ */
164
+ status?: number | undefined;
165
+ /**
166
+ * <p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>
167
+ * @public
168
+ */
169
+ otpEnabled?: boolean | undefined;
170
+ /**
171
+ * <p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>
172
+ * @public
173
+ */
174
+ scimId?: string | undefined;
175
+ /**
176
+ * <p>The descriptive type of the user account (e.g., 'user').</p>
177
+ * @public
178
+ */
179
+ type?: string | undefined;
180
+ /**
181
+ * <p>The phone number minus country code, used for cloud deployments.</p>
182
+ * @public
183
+ */
184
+ cell?: string | undefined;
185
+ /**
186
+ * <p>The country code for the user's phone number, used for cloud deployments.</p>
187
+ * @public
188
+ */
189
+ countryCode?: string | undefined;
190
+ /**
191
+ * <p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>
192
+ * @public
193
+ */
194
+ challengeFailures?: number | undefined;
195
+ /**
196
+ * <p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>
197
+ * @public
198
+ */
199
+ isInviteExpired?: boolean | undefined;
200
+ /**
201
+ * <p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>
202
+ * @public
203
+ */
204
+ isUser?: boolean | undefined;
205
+ /**
206
+ * <p>The invitation code for this user, used during registration to join the network.</p>
207
+ * @public
208
+ */
209
+ inviteCode?: string | undefined;
210
+ /**
211
+ * <p>Indicates whether the user can be verified through a custom invite code.</p>
212
+ * @public
213
+ */
214
+ codeValidation?: boolean | undefined;
215
+ /**
216
+ * <p>The unique identifier for the user.</p>
217
+ * @public
218
+ */
219
+ uname?: string | undefined;
220
+ }
221
+ /**
222
+ * @public
223
+ */
224
+ export interface BatchCreateUserResponse {
225
+ /**
226
+ * <p>A message indicating the overall result of the batch operation.</p>
227
+ * @public
228
+ */
229
+ message?: string | undefined;
230
+ /**
231
+ * <p>A list of user objects that were successfully created, including their assigned user IDs and invite codes.</p>
232
+ * @public
233
+ */
234
+ successful?: User[] | undefined;
235
+ /**
236
+ * <p>A list of user creation attempts that failed, including error details explaining why each user could not be created.</p>
237
+ * @public
238
+ */
239
+ failed?: BatchUserErrorResponseItem[] | undefined;
240
+ }
241
+ /**
242
+ * <p>Contains detailed error information explaining why an operation failed, including which field caused the error and the reason for the failure.</p>
243
+ * @public
244
+ */
245
+ export interface ErrorDetail {
246
+ /**
247
+ * <p>The name of the field that contains an error or warning.</p>
248
+ * @public
249
+ */
250
+ field?: string | undefined;
251
+ /**
252
+ * <p>A detailed description of the error or warning.</p>
253
+ * @public
254
+ */
255
+ reason?: string | undefined;
256
+ }
257
+ /**
258
+ * @public
259
+ */
260
+ export interface BatchDeleteUserRequest {
261
+ /**
262
+ * <p>The ID of the Wickr network from which users will be deleted.</p>
263
+ * @public
264
+ */
265
+ networkId: string | undefined;
266
+ /**
267
+ * <p>A list of user IDs identifying the users to be deleted from the network. Maximum 50 users per batch request.</p>
268
+ * @public
269
+ */
270
+ userIds: string[] | undefined;
271
+ /**
272
+ * <p>A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete users again.</p>
273
+ * @public
274
+ */
275
+ clientToken?: string | undefined;
276
+ }
277
+ /**
278
+ * <p>Contains information about a user that was successfully processed in a batch user operation.</p>
279
+ * @public
280
+ */
281
+ export interface BatchUserSuccessResponseItem {
282
+ /**
283
+ * <p>The user ID that was successfully processed.</p>
284
+ * @public
285
+ */
286
+ userId: string | undefined;
287
+ }
288
+ /**
289
+ * @public
290
+ */
291
+ export interface BatchDeleteUserResponse {
292
+ /**
293
+ * <p>A message indicating the overall result of the batch deletion operation.</p>
294
+ * @public
295
+ */
296
+ message?: string | undefined;
297
+ /**
298
+ * <p>A list of user IDs that were successfully deleted from the network.</p>
299
+ * @public
300
+ */
301
+ successful?: BatchUserSuccessResponseItem[] | undefined;
302
+ /**
303
+ * <p>A list of user deletion attempts that failed, including error details explaining why each user could not be deleted.</p>
304
+ * @public
305
+ */
306
+ failed?: BatchUserErrorResponseItem[] | undefined;
307
+ }
308
+ /**
309
+ * <p>Contains error information for a device operation that failed in a batch device request.</p>
310
+ * @public
311
+ */
312
+ export interface BatchDeviceErrorResponseItem {
313
+ /**
314
+ * <p>The field that caused the error.</p>
315
+ * @public
316
+ */
317
+ field?: string | undefined;
318
+ /**
319
+ * <p>A description of why the device operation failed.</p>
320
+ * @public
321
+ */
322
+ reason?: string | undefined;
323
+ /**
324
+ * <p>The application ID of the device that failed to be processed.</p>
325
+ * @public
326
+ */
327
+ appId: string | undefined;
328
+ }
329
+ /**
330
+ * <p>Contains information about a device that was successfully processed in a batch device operation.</p>
331
+ * @public
332
+ */
333
+ export interface BatchDeviceSuccessResponseItem {
334
+ /**
335
+ * <p>The application ID of the device that was successfully processed.</p>
336
+ * @public
337
+ */
338
+ appId: string | undefined;
339
+ }
340
+ /**
341
+ * @public
342
+ */
343
+ export interface BatchLookupUserUnameRequest {
344
+ /**
345
+ * <p>The ID of the Wickr network where the users will be looked up.</p>
346
+ * @public
347
+ */
348
+ networkId: string | undefined;
349
+ /**
350
+ * <p>A list of username hashes (unames) to look up. Each uname is a unique identifier for a user's username. Maximum 50 unames per batch request.</p>
351
+ * @public
352
+ */
353
+ unames: string[] | undefined;
354
+ /**
355
+ * <p>A unique identifier for this request to ensure idempotency.</p>
356
+ * @public
357
+ */
358
+ clientToken?: string | undefined;
359
+ }
360
+ /**
361
+ * <p>Contains error information for a username hash lookup that failed in a batch uname lookup request.</p>
362
+ * @public
363
+ */
364
+ export interface BatchUnameErrorResponseItem {
365
+ /**
366
+ * <p>The field that caused the error.</p>
367
+ * @public
368
+ */
369
+ field?: string | undefined;
370
+ /**
371
+ * <p>A description of why the username hash lookup failed.</p>
372
+ * @public
373
+ */
374
+ reason?: string | undefined;
375
+ /**
376
+ * <p>The username hash that failed to be looked up.</p>
377
+ * @public
378
+ */
379
+ uname: string | undefined;
380
+ }
381
+ /**
382
+ * <p>Contains information about a username hash that was successfully resolved in a batch uname lookup operation.</p>
383
+ * @public
384
+ */
385
+ export interface BatchUnameSuccessResponseItem {
386
+ /**
387
+ * <p>The username hash that was successfully resolved.</p>
388
+ * @public
389
+ */
390
+ uname: string | undefined;
391
+ /**
392
+ * <p>The email address or username corresponding to the username hash.</p>
393
+ * @public
394
+ */
395
+ username: string | undefined;
396
+ }
397
+ /**
398
+ * @public
399
+ */
400
+ export interface BatchLookupUserUnameResponse {
401
+ /**
402
+ * <p>A message indicating the overall result of the batch lookup operation.</p>
403
+ * @public
404
+ */
405
+ message?: string | undefined;
406
+ /**
407
+ * <p>A list of successfully resolved username hashes with their corresponding email addresses.</p>
408
+ * @public
409
+ */
410
+ successful?: BatchUnameSuccessResponseItem[] | undefined;
411
+ /**
412
+ * <p>A list of username hash lookup attempts that failed, including error details explaining why each lookup failed.</p>
413
+ * @public
414
+ */
415
+ failed?: BatchUnameErrorResponseItem[] | undefined;
416
+ }
417
+ /**
418
+ * @public
419
+ */
420
+ export interface BatchReinviteUserRequest {
421
+ /**
422
+ * <p>The ID of the Wickr network where users will be reinvited.</p>
423
+ * @public
424
+ */
425
+ networkId: string | undefined;
426
+ /**
427
+ * <p>A list of user IDs identifying the users to be reinvited to the network. Maximum 50 users per batch request.</p>
428
+ * @public
429
+ */
430
+ userIds: string[] | undefined;
431
+ /**
432
+ * <p>A unique identifier for this request to ensure idempotency.</p>
433
+ * @public
434
+ */
435
+ clientToken?: string | undefined;
436
+ }
437
+ /**
438
+ * @public
439
+ */
440
+ export interface BatchReinviteUserResponse {
441
+ /**
442
+ * <p>A message indicating the overall result of the batch reinvitation operation.</p>
443
+ * @public
444
+ */
445
+ message?: string | undefined;
446
+ /**
447
+ * <p>A list of user IDs that were successfully reinvited.</p>
448
+ * @public
449
+ */
450
+ successful?: BatchUserSuccessResponseItem[] | undefined;
451
+ /**
452
+ * <p>A list of reinvitation attempts that failed, including error details explaining why each user could not be reinvited.</p>
453
+ * @public
454
+ */
455
+ failed?: BatchUserErrorResponseItem[] | undefined;
456
+ }
457
+ /**
458
+ * @public
459
+ */
460
+ export interface BatchResetDevicesForUserRequest {
461
+ /**
462
+ * <p>The ID of the Wickr network containing the user whose devices will be reset.</p>
463
+ * @public
464
+ */
465
+ networkId: string | undefined;
466
+ /**
467
+ * <p>The ID of the user whose devices will be reset.</p>
468
+ * @public
469
+ */
470
+ userId: string | undefined;
471
+ /**
472
+ * <p>A list of application IDs identifying the specific devices to be reset for the user. Maximum 50 devices per batch request.</p>
473
+ * @public
474
+ */
475
+ appIds: string[] | undefined;
476
+ /**
477
+ * <p>A unique identifier for this request to ensure idempotency.</p>
478
+ * @public
479
+ */
480
+ clientToken?: string | undefined;
481
+ }
482
+ /**
483
+ * @public
484
+ */
485
+ export interface BatchResetDevicesForUserResponse {
486
+ /**
487
+ * <p>A message indicating the overall result of the batch device reset operation.</p>
488
+ * @public
489
+ */
490
+ message?: string | undefined;
491
+ /**
492
+ * <p>A list of application IDs that were successfully reset.</p>
493
+ * @public
494
+ */
495
+ successful?: BatchDeviceSuccessResponseItem[] | undefined;
496
+ /**
497
+ * <p>A list of device reset attempts that failed, including error details explaining why each device could not be reset.</p>
498
+ * @public
499
+ */
500
+ failed?: BatchDeviceErrorResponseItem[] | undefined;
501
+ }
502
+ /**
503
+ * @public
504
+ */
505
+ export interface BatchToggleUserSuspendStatusRequest {
506
+ /**
507
+ * <p>The ID of the Wickr network where users will be suspended or unsuspended.</p>
508
+ * @public
509
+ */
510
+ networkId: string | undefined;
511
+ /**
512
+ * <p>A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.</p>
513
+ * @public
514
+ */
515
+ suspend: boolean | undefined;
516
+ /**
517
+ * <p>A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.</p>
518
+ * @public
519
+ */
520
+ userIds: string[] | undefined;
521
+ /**
522
+ * <p>A unique identifier for this request to ensure idempotency.</p>
523
+ * @public
524
+ */
525
+ clientToken?: string | undefined;
526
+ }
527
+ /**
528
+ * @public
529
+ */
530
+ export interface BatchToggleUserSuspendStatusResponse {
531
+ /**
532
+ * <p>A message indicating the overall result of the batch suspend status toggle operation.</p>
533
+ * @public
534
+ */
535
+ message?: string | undefined;
536
+ /**
537
+ * <p>A list of user IDs whose suspend status was successfully toggled.</p>
538
+ * @public
539
+ */
540
+ successful?: BatchUserSuccessResponseItem[] | undefined;
541
+ /**
542
+ * <p>A list of suspend status toggle attempts that failed, including error details explaining why each user's status could not be changed.</p>
543
+ * @public
544
+ */
545
+ failed?: BatchUserErrorResponseItem[] | undefined;
546
+ }
547
+ /**
548
+ * <p>Represents a guest user who has been blocked from accessing a Wickr network.</p>
549
+ * @public
550
+ */
551
+ export interface BlockedGuestUser {
552
+ /**
553
+ * <p>The username of the blocked guest user.</p>
554
+ * @public
555
+ */
556
+ username: string | undefined;
557
+ /**
558
+ * <p>The username of the administrator who blocked this guest user.</p>
559
+ * @public
560
+ */
561
+ admin: string | undefined;
562
+ /**
563
+ * <p>The timestamp when the guest user was blocked or last modified.</p>
564
+ * @public
565
+ */
566
+ modified: string | undefined;
567
+ /**
568
+ * <p>The unique username hash identifier for the blocked guest user.</p>
569
+ * @public
570
+ */
571
+ usernameHash: string | undefined;
572
+ }
573
+ /**
574
+ * <p>Represents a bot account in a Wickr network with all its informational fields.</p>
575
+ * @public
576
+ */
577
+ export interface Bot {
578
+ /**
579
+ * <p>The unique identifier of the bot.</p>
580
+ * @public
581
+ */
582
+ botId?: string | undefined;
583
+ /**
584
+ * <p>The display name of the bot that is visible to users.</p>
585
+ * @public
586
+ */
587
+ displayName?: string | undefined;
588
+ /**
589
+ * <p>The username of the bot.</p>
590
+ * @public
591
+ */
592
+ username?: string | undefined;
593
+ /**
594
+ * <p>The unique username hash identifier for the bot.</p>
595
+ * @public
596
+ */
597
+ uname?: string | undefined;
598
+ /**
599
+ * <p>The public key of the bot used for encryption.</p>
600
+ * @public
601
+ */
602
+ pubkey?: string | undefined;
603
+ /**
604
+ * <p>The current status of the bot (1 for pending, 2 for active).</p>
605
+ * @public
606
+ */
607
+ status?: BotStatus | undefined;
608
+ /**
609
+ * <p>The ID of the security group to which the bot belongs.</p>
610
+ * @public
611
+ */
612
+ groupId?: string | undefined;
613
+ /**
614
+ * <p>Indicates whether the bot has a password set.</p>
615
+ * @public
616
+ */
617
+ hasChallenge?: boolean | undefined;
618
+ /**
619
+ * <p>Indicates whether the bot is currently suspended.</p>
620
+ * @public
621
+ */
622
+ suspended?: boolean | undefined;
623
+ /**
624
+ * <p>The timestamp of the bot's last login.</p>
625
+ * @public
626
+ */
627
+ lastLogin?: string | undefined;
628
+ }
629
+ /**
630
+ * <p>Defines the calling feature permissions and settings for users in a security group, controlling what types of calls users can initiate and participate in.</p>
631
+ * @public
632
+ */
633
+ export interface CallingSettings {
634
+ /**
635
+ * <p>Specifies whether users can start one-to-one calls.</p>
636
+ * @public
637
+ */
638
+ canStart11Call?: boolean | undefined;
639
+ /**
640
+ * <p>Specifies whether users can make video calls (as opposed to audio-only calls). Valid only when audio call(canStart11Call) is enabled.</p>
641
+ * @public
642
+ */
643
+ canVideoCall?: boolean | undefined;
644
+ /**
645
+ * <p>When enabled, forces all calls to use TCP protocol instead of UDP for network traversal.</p>
646
+ * @public
647
+ */
648
+ forceTcpCall?: boolean | undefined;
649
+ }
650
+ /**
651
+ * @public
652
+ */
653
+ export interface CreateBotRequest {
654
+ /**
655
+ * <p>The ID of the Wickr network where the bot will be created.</p>
656
+ * @public
657
+ */
658
+ networkId: string | undefined;
659
+ /**
660
+ * <p>The username for the bot. This must be unique within the network and follow the network's naming conventions.</p>
661
+ * @public
662
+ */
663
+ username: string | undefined;
664
+ /**
665
+ * <p>The display name for the bot that will be visible to users in the network.</p>
666
+ * @public
667
+ */
668
+ displayName?: string | undefined;
669
+ /**
670
+ * <p>The ID of the security group to which the bot will be assigned.</p>
671
+ * @public
672
+ */
673
+ groupId: string | undefined;
674
+ /**
675
+ * <p>The password for the bot account.</p>
676
+ * @public
677
+ */
678
+ challenge: string | undefined;
679
+ }
680
+ /**
681
+ * @public
682
+ */
683
+ export interface CreateBotResponse {
684
+ /**
685
+ * <p>A message indicating the result of the bot creation operation.</p>
686
+ * @public
687
+ */
688
+ message?: string | undefined;
689
+ /**
690
+ * <p>The unique identifier assigned to the newly created bot.</p>
691
+ * @public
692
+ */
693
+ botId: string | undefined;
694
+ /**
695
+ * <p>The ID of the network where the bot was created.</p>
696
+ * @public
697
+ */
698
+ networkId?: string | undefined;
699
+ /**
700
+ * <p>The username of the newly created bot.</p>
701
+ * @public
702
+ */
703
+ username?: string | undefined;
704
+ /**
705
+ * <p>The display name of the newly created bot.</p>
706
+ * @public
707
+ */
708
+ displayName?: string | undefined;
709
+ /**
710
+ * <p>The ID of the security group to which the bot was assigned.</p>
711
+ * @public
712
+ */
713
+ groupId?: string | undefined;
714
+ }
715
+ /**
716
+ * @public
717
+ */
718
+ export interface CreateDataRetentionBotRequest {
719
+ /**
720
+ * <p>The ID of the Wickr network where the data retention bot will be created.</p>
721
+ * @public
722
+ */
723
+ networkId: string | undefined;
724
+ }
725
+ /**
726
+ * @public
727
+ */
728
+ export interface CreateDataRetentionBotResponse {
729
+ /**
730
+ * <p>A message indicating that the data retention bot was successfully provisioned.</p>
731
+ * @public
732
+ */
733
+ message?: string | undefined;
734
+ }
735
+ /**
736
+ * @public
737
+ */
738
+ export interface CreateDataRetentionBotChallengeRequest {
739
+ /**
740
+ * <p>The ID of the Wickr network containing the data retention bot.</p>
741
+ * @public
742
+ */
743
+ networkId: string | undefined;
744
+ }
745
+ /**
746
+ * @public
747
+ */
748
+ export interface CreateDataRetentionBotChallengeResponse {
749
+ /**
750
+ * <p>The newly generated challenge password for the data retention bot.</p>
751
+ * @public
752
+ */
753
+ challenge: string | undefined;
754
+ }
755
+ /**
756
+ * @public
757
+ */
758
+ export interface CreateNetworkRequest {
759
+ /**
760
+ * <p>The name for the new network. Must be between 1 and 20 characters.</p>
761
+ * @public
762
+ */
763
+ networkName: string | undefined;
764
+ /**
765
+ * <p>The access level for the network. Valid values are STANDARD or PREMIUM, which determine the features and capabilities available to network members.</p>
766
+ * @public
767
+ */
768
+ accessLevel: AccessLevel | undefined;
769
+ /**
770
+ * <p>Specifies whether to enable a premium free trial for the network. It is optional and has a default value as false. When set to true, the network starts with premium features for a limited trial period. </p>
771
+ * @public
772
+ */
773
+ enablePremiumFreeTrial?: boolean | undefined;
774
+ /**
775
+ * <p>The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.</p>
776
+ * @public
777
+ */
778
+ encryptionKeyArn?: string | undefined;
779
+ }
780
+ /**
781
+ * @public
782
+ */
783
+ export interface CreateNetworkResponse {
784
+ /**
785
+ * <p>The unique identifier assigned to the newly created network.</p>
786
+ * @public
787
+ */
788
+ networkId?: string | undefined;
789
+ /**
790
+ * <p>The name of the newly created network.</p>
791
+ * @public
792
+ */
793
+ networkName?: string | undefined;
794
+ /**
795
+ * <p>The ARN of the KMS key being used to encrypt sensitive data in the network.</p>
796
+ * @public
797
+ */
798
+ encryptionKeyArn?: string | undefined;
799
+ }
800
+ /**
801
+ * <p>Identifies a Amazon Web Services Wickr network by region and network ID, used for configuring permitted networks for global federation.</p>
802
+ * @public
803
+ */
804
+ export interface WickrAwsNetworks {
805
+ /**
806
+ * <p>The Amazon Web Services region identifier where the network is hosted (e.g., 'us-east-1').</p>
807
+ * @public
808
+ */
809
+ region: string | undefined;
810
+ /**
811
+ * <p>The network ID of the Wickr Amazon Web Services network.</p>
812
+ * @public
813
+ */
814
+ networkId: string | undefined;
815
+ }
816
+ /**
817
+ * <p>Identifies a Wickr enterprise network that is permitted for global federation, allowing users to communicate with members of the specified network.</p>
818
+ * @public
819
+ */
820
+ export interface PermittedWickrEnterpriseNetwork {
821
+ /**
822
+ * <p>The domain identifier for the permitted Wickr enterprise network.</p>
823
+ * @public
824
+ */
825
+ domain: string | undefined;
826
+ /**
827
+ * <p>The network ID of the permitted Wickr enterprise network.</p>
828
+ * @public
829
+ */
830
+ networkId: string | undefined;
831
+ }
832
+ /**
833
+ * <p>Contains the security group configuration settings that can be specified when creating or updating a security group. This is a subset of SecurityGroupSettings containing only the modifiable federation and security settings.</p>
834
+ * @public
835
+ */
836
+ export interface SecurityGroupSettingsRequest {
837
+ /**
838
+ * <p>The number of failed password attempts before a user account is locked out.</p>
839
+ * @public
840
+ */
841
+ lockoutThreshold?: number | undefined;
842
+ /**
843
+ * <p>A list of network IDs that are permitted for local federation when federation mode is set to restricted.</p>
844
+ * @public
845
+ */
846
+ permittedNetworks?: string[] | undefined;
847
+ /**
848
+ * <p>Guest users let you work with people outside your organization that only have limited access to Wickr. Only valid when federationMode is set to Global.</p>
849
+ * @public
850
+ */
851
+ enableGuestFederation?: boolean | undefined;
852
+ /**
853
+ * <p>Allow users to securely federate with all Amazon Web Services Wickr networks and Amazon Web Services Enterprise networks.</p>
854
+ * @public
855
+ */
856
+ globalFederation?: boolean | undefined;
857
+ /**
858
+ * <p>The local federation mode. Values: 0 (none), 1 (federated - all networks), 2 (restricted - only permitted networks).</p>
859
+ * @public
860
+ */
861
+ federationMode?: number | undefined;
862
+ /**
863
+ * <p>Enables restricted global federation to limit communication to specific permitted networks only. Requires globalFederation to be enabled.</p>
864
+ * @public
865
+ */
866
+ enableRestrictedGlobalFederation?: boolean | undefined;
867
+ /**
868
+ * <p>A list of permitted Amazon Web Services Wickr networks for restricted global federation.</p>
869
+ * @public
870
+ */
871
+ permittedWickrAwsNetworks?: WickrAwsNetworks[] | undefined;
872
+ /**
873
+ * <p>A list of permitted Wickr Enterprise networks for restricted global federation.</p>
874
+ * @public
875
+ */
876
+ permittedWickrEnterpriseNetworks?: PermittedWickrEnterpriseNetwork[] | undefined;
877
+ }
878
+ /**
879
+ * @public
880
+ */
881
+ export interface CreateSecurityGroupRequest {
882
+ /**
883
+ * <p>The ID of the Wickr network where the security group will be created.</p>
884
+ * @public
885
+ */
886
+ networkId: string | undefined;
887
+ /**
888
+ * <p>The name for the new security group.</p>
889
+ * @public
890
+ */
891
+ name: string | undefined;
892
+ /**
893
+ * <p>The configuration settings for the security group, including permissions, federation settings, and feature controls.</p>
894
+ * @public
895
+ */
896
+ securityGroupSettings: SecurityGroupSettingsRequest | undefined;
897
+ /**
898
+ * <p>A unique identifier for this request to ensure idempotency.</p>
899
+ * @public
900
+ */
901
+ clientToken?: string | undefined;
902
+ }
903
+ /**
904
+ * <p>Defines password complexity requirements for users in a security group, including minimum length and character type requirements.</p>
905
+ * @public
906
+ */
907
+ export interface PasswordRequirements {
908
+ /**
909
+ * <p>The minimum number of lowercase letters required in passwords.</p>
910
+ * @public
911
+ */
912
+ lowercase?: number | undefined;
913
+ /**
914
+ * <p>The minimum password length in characters.</p>
915
+ * @public
916
+ */
917
+ minLength?: number | undefined;
918
+ /**
919
+ * <p>The minimum number of numeric characters required in passwords.</p>
920
+ * @public
921
+ */
922
+ numbers?: number | undefined;
923
+ /**
924
+ * <p>The minimum number of special symbol characters required in passwords.</p>
925
+ * @public
926
+ */
927
+ symbols?: number | undefined;
928
+ /**
929
+ * <p>The minimum number of uppercase letters required in passwords.</p>
930
+ * @public
931
+ */
932
+ uppercase?: number | undefined;
933
+ }
934
+ /**
935
+ * <p>Configuration for the message shredder feature, which securely deletes messages and files from devices to prevent data recovery.</p>
936
+ * @public
937
+ */
938
+ export interface ShredderSettings {
939
+ /**
940
+ * <p>Specifies whether users can manually trigger the shredder to delete content.</p>
941
+ * @public
942
+ */
943
+ canProcessManually?: boolean | undefined;
944
+ /**
945
+ * <p>Prevents Wickr data from being recovered by overwriting deleted Wickr data. Valid Values: Must be one of [0, 20, 60, 100]</p>
946
+ * @public
947
+ */
948
+ intensity?: number | undefined;
949
+ }
950
+ /**
951
+ * <p>Comprehensive configuration settings that define all user capabilities, restrictions, and features for members of a security group. These settings control everything from calling permissions to federation settings to security policies.</p>
952
+ * @public
953
+ */
954
+ export interface SecurityGroupSettings {
955
+ /**
956
+ * <p>Requires users to reauthenticate every time they return to the application, providing an additional layer of security.</p>
957
+ * @public
958
+ */
959
+ alwaysReauthenticate?: boolean | undefined;
960
+ /**
961
+ * <p>Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.</p>
962
+ * @public
963
+ */
964
+ atakPackageValues?: string[] | undefined;
965
+ /**
966
+ * <p>The calling feature permissions and settings that control what types of calls users can initiate and participate in.</p>
967
+ * @public
968
+ */
969
+ calling?: CallingSettings | undefined;
970
+ /**
971
+ * <p>Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.</p>
972
+ * @public
973
+ */
974
+ checkForUpdates?: boolean | undefined;
975
+ /**
976
+ * <p>Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.</p>
977
+ * @public
978
+ */
979
+ enableAtak?: boolean | undefined;
980
+ /**
981
+ * <p>Allow users to report crashes.</p>
982
+ * @public
983
+ */
984
+ enableCrashReports?: boolean | undefined;
985
+ /**
986
+ * <p>Specifies whether users can download files from messages to their devices.</p>
987
+ * @public
988
+ */
989
+ enableFileDownload?: boolean | undefined;
990
+ /**
991
+ * <p>Allows users to communicate with guest users from other Wickr networks and federated external networks.</p>
992
+ * @public
993
+ */
994
+ enableGuestFederation?: boolean | undefined;
995
+ /**
996
+ * <p>Enables message preview text in push notifications, allowing users to see message content before opening the app.</p>
997
+ * @public
998
+ */
999
+ enableNotificationPreview?: boolean | undefined;
1000
+ /**
1001
+ * <p> Allow users to avoid censorship when they are geo-blocked or have network limitations.</p>
1002
+ * @public
1003
+ */
1004
+ enableOpenAccessOption?: boolean | undefined;
1005
+ /**
1006
+ * <p>Enables restricted global federation, limiting external communication to only specified permitted networks.</p>
1007
+ * @public
1008
+ */
1009
+ enableRestrictedGlobalFederation?: boolean | undefined;
1010
+ /**
1011
+ * <p>Enables file sharing capabilities, allowing users to send and receive files in conversations.</p>
1012
+ * @public
1013
+ */
1014
+ filesEnabled?: boolean | undefined;
1015
+ /**
1016
+ * <p> Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.</p>
1017
+ * @public
1018
+ */
1019
+ forceDeviceLockout?: number | undefined;
1020
+ /**
1021
+ * <p>Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.</p>
1022
+ * @public
1023
+ */
1024
+ forceOpenAccess?: boolean | undefined;
1025
+ /**
1026
+ * <p>Allow user approved bots to read messages in rooms without using a slash command.</p>
1027
+ * @public
1028
+ */
1029
+ forceReadReceipts?: boolean | undefined;
1030
+ /**
1031
+ * <p>Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.</p>
1032
+ * @public
1033
+ */
1034
+ globalFederation?: boolean | undefined;
1035
+ /**
1036
+ * <p>Enforces a two-factor authentication when a user adds a new device to their account.</p>
1037
+ * @public
1038
+ */
1039
+ isAtoEnabled?: boolean | undefined;
1040
+ /**
1041
+ * <p>Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.</p>
1042
+ * @public
1043
+ */
1044
+ isLinkPreviewEnabled?: boolean | undefined;
1045
+ /**
1046
+ * <p>Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.</p>
1047
+ * @public
1048
+ */
1049
+ locationAllowMaps?: boolean | undefined;
1050
+ /**
1051
+ * <p>Enables location sharing features, allowing users to share their current location with others.</p>
1052
+ * @public
1053
+ */
1054
+ locationEnabled?: boolean | undefined;
1055
+ /**
1056
+ * <p>The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]</p>
1057
+ * @public
1058
+ */
1059
+ maxAutoDownloadSize?: number | undefined;
1060
+ /**
1061
+ * <p>The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.</p>
1062
+ * @public
1063
+ */
1064
+ maxBor?: number | undefined;
1065
+ /**
1066
+ * <p>The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.</p>
1067
+ * @public
1068
+ */
1069
+ maxTtl?: number | undefined;
1070
+ /**
1071
+ * <p>Enables message forwarding, allowing users to forward messages from one conversation to another.</p>
1072
+ * @public
1073
+ */
1074
+ messageForwardingEnabled?: boolean | undefined;
1075
+ /**
1076
+ * <p>The password complexity requirements that users must follow when creating or changing passwords.</p>
1077
+ * @public
1078
+ */
1079
+ passwordRequirements?: PasswordRequirements | undefined;
1080
+ /**
1081
+ * <p>Enables presence indicators that show whether users are online, away, or offline.</p>
1082
+ * @public
1083
+ */
1084
+ presenceEnabled?: boolean | undefined;
1085
+ /**
1086
+ * <p>A list of pre-defined quick response message templates that users can send with a single tap.</p>
1087
+ * @public
1088
+ */
1089
+ quickResponses?: string[] | undefined;
1090
+ /**
1091
+ * <p>Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.</p>
1092
+ * @public
1093
+ */
1094
+ showMasterRecoveryKey?: boolean | undefined;
1095
+ /**
1096
+ * <p>The message shredder configuration that controls secure deletion of messages and files from devices.</p>
1097
+ * @public
1098
+ */
1099
+ shredder?: ShredderSettings | undefined;
1100
+ /**
1101
+ * <p>The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.</p>
1102
+ * @public
1103
+ */
1104
+ ssoMaxIdleMinutes?: number | undefined;
1105
+ /**
1106
+ * <p>The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).</p>
1107
+ * @public
1108
+ */
1109
+ federationMode?: number | undefined;
1110
+ /**
1111
+ * <p>The number of failed password attempts before a user account is locked out.</p>
1112
+ * @public
1113
+ */
1114
+ lockoutThreshold?: number | undefined;
1115
+ /**
1116
+ * <p>A list of network IDs that are permitted for local federation when federation mode is set to restricted.</p>
1117
+ * @public
1118
+ */
1119
+ permittedNetworks?: string[] | undefined;
1120
+ /**
1121
+ * <p>A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.</p>
1122
+ * @public
1123
+ */
1124
+ permittedWickrAwsNetworks?: WickrAwsNetworks[] | undefined;
1125
+ /**
1126
+ * <p>A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.</p>
1127
+ * @public
1128
+ */
1129
+ permittedWickrEnterpriseNetworks?: PermittedWickrEnterpriseNetwork[] | undefined;
1130
+ }
1131
+ /**
1132
+ * <p>Represents a security group in a Wickr network, containing membership statistics, configuration, and all permission settings that apply to its members.</p>
1133
+ * @public
1134
+ */
1135
+ export interface SecurityGroup {
1136
+ /**
1137
+ * <p>The number of active user members currently in the security group.</p>
1138
+ * @public
1139
+ */
1140
+ activeMembers: number | undefined;
1141
+ /**
1142
+ * <p>The number of bot members currently in the security group.</p>
1143
+ * @public
1144
+ */
1145
+ botMembers: number | undefined;
1146
+ /**
1147
+ * <p>The GUID of the Active Directory group associated with this security group, if synchronized with LDAP.</p>
1148
+ * @public
1149
+ */
1150
+ activeDirectoryGuid?: string | undefined;
1151
+ /**
1152
+ * <p>The unique identifier of the security group.</p>
1153
+ * @public
1154
+ */
1155
+ id: string | undefined;
1156
+ /**
1157
+ * <p>Indicates whether this is the default security group for the network. Each network has only one default group.</p>
1158
+ * @public
1159
+ */
1160
+ isDefault: boolean | undefined;
1161
+ /**
1162
+ * <p>The human-readable name of the security group.</p>
1163
+ * @public
1164
+ */
1165
+ name: string | undefined;
1166
+ /**
1167
+ * <p>The timestamp when the security group was last modified, specified in epoch seconds.</p>
1168
+ * @public
1169
+ */
1170
+ modified: number | undefined;
1171
+ /**
1172
+ * <p>The comprehensive configuration settings that define capabilities and restrictions for members of this security group.</p>
1173
+ * @public
1174
+ */
1175
+ securityGroupSettings: SecurityGroupSettings | undefined;
1176
+ }
1177
+ /**
1178
+ * @public
1179
+ */
1180
+ export interface CreateSecurityGroupResponse {
1181
+ /**
1182
+ * <p>The details of the newly created security group, including its ID, name, and settings.</p>
1183
+ * @public
1184
+ */
1185
+ securityGroup: SecurityGroup | undefined;
1186
+ }
1187
+ /**
1188
+ * @public
1189
+ */
1190
+ export interface DeleteBotRequest {
1191
+ /**
1192
+ * <p>The ID of the Wickr network from which the bot will be deleted.</p>
1193
+ * @public
1194
+ */
1195
+ networkId: string | undefined;
1196
+ /**
1197
+ * <p>The unique identifier of the bot to be deleted.</p>
1198
+ * @public
1199
+ */
1200
+ botId: string | undefined;
1201
+ }
1202
+ /**
1203
+ * @public
1204
+ */
1205
+ export interface DeleteBotResponse {
1206
+ /**
1207
+ * <p>A message indicating the result of the bot deletion operation.</p>
1208
+ * @public
1209
+ */
1210
+ message?: string | undefined;
1211
+ }
1212
+ /**
1213
+ * @public
1214
+ */
1215
+ export interface DeleteDataRetentionBotRequest {
1216
+ /**
1217
+ * <p>The ID of the Wickr network from which the data retention bot will be deleted.</p>
1218
+ * @public
1219
+ */
1220
+ networkId: string | undefined;
1221
+ }
1222
+ /**
1223
+ * @public
1224
+ */
1225
+ export interface DeleteDataRetentionBotResponse {
1226
+ /**
1227
+ * <p>A message indicating that the data retention bot and all associated data were successfully deleted.</p>
1228
+ * @public
1229
+ */
1230
+ message?: string | undefined;
1231
+ }
1232
+ /**
1233
+ * @public
1234
+ */
1235
+ export interface DeleteNetworkRequest {
1236
+ /**
1237
+ * <p>The ID of the Wickr network to delete.</p>
1238
+ * @public
1239
+ */
1240
+ networkId: string | undefined;
1241
+ /**
1242
+ * <p>A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without attempting to delete the network again.</p>
1243
+ * @public
1244
+ */
1245
+ clientToken?: string | undefined;
1246
+ }
1247
+ /**
1248
+ * @public
1249
+ */
1250
+ export interface DeleteNetworkResponse {
1251
+ /**
1252
+ * <p>A message indicating that the network deletion has been initiated successfully.</p>
1253
+ * @public
1254
+ */
1255
+ message?: string | undefined;
1256
+ }
1257
+ /**
1258
+ * @public
1259
+ */
1260
+ export interface DeleteSecurityGroupRequest {
1261
+ /**
1262
+ * <p>The ID of the Wickr network from which the security group will be deleted.</p>
1263
+ * @public
1264
+ */
1265
+ networkId: string | undefined;
1266
+ /**
1267
+ * <p>The unique identifier of the security group to delete.</p>
1268
+ * @public
1269
+ */
1270
+ groupId: string | undefined;
1271
+ }
1272
+ /**
1273
+ * @public
1274
+ */
1275
+ export interface DeleteSecurityGroupResponse {
1276
+ /**
1277
+ * <p>A message indicating the result of the security group deletion operation.</p>
1278
+ * @public
1279
+ */
1280
+ message?: string | undefined;
1281
+ /**
1282
+ * <p>The ID of the network from which the security group was deleted.</p>
1283
+ * @public
1284
+ */
1285
+ networkId?: string | undefined;
1286
+ /**
1287
+ * <p>The ID of the security group that was deleted.</p>
1288
+ * @public
1289
+ */
1290
+ groupId?: string | undefined;
1291
+ }
1292
+ /**
1293
+ * @public
1294
+ */
1295
+ export interface GetBotRequest {
1296
+ /**
1297
+ * <p>The ID of the Wickr network containing the bot.</p>
1298
+ * @public
1299
+ */
1300
+ networkId: string | undefined;
1301
+ /**
1302
+ * <p>The unique identifier of the bot to retrieve.</p>
1303
+ * @public
1304
+ */
1305
+ botId: string | undefined;
1306
+ }
1307
+ /**
1308
+ * @public
1309
+ */
1310
+ export interface GetBotResponse {
1311
+ /**
1312
+ * <p>The unique identifier of the bot.</p>
1313
+ * @public
1314
+ */
1315
+ botId?: string | undefined;
1316
+ /**
1317
+ * <p>The display name of the bot that is visible to users.</p>
1318
+ * @public
1319
+ */
1320
+ displayName?: string | undefined;
1321
+ /**
1322
+ * <p>The username of the bot.</p>
1323
+ * @public
1324
+ */
1325
+ username?: string | undefined;
1326
+ /**
1327
+ * <p>The unique username hash identifier for the bot.</p>
1328
+ * @public
1329
+ */
1330
+ uname?: string | undefined;
1331
+ /**
1332
+ * <p>The public key of the bot used for encryption.</p>
1333
+ * @public
1334
+ */
1335
+ pubkey?: string | undefined;
1336
+ /**
1337
+ * <p>The current status of the bot (1 for pending, 2 for active).</p>
1338
+ * @public
1339
+ */
1340
+ status?: BotStatus | undefined;
1341
+ /**
1342
+ * <p>The ID of the security group to which the bot belongs.</p>
1343
+ * @public
1344
+ */
1345
+ groupId?: string | undefined;
1346
+ /**
1347
+ * <p>Indicates whether the bot has a password set.</p>
1348
+ * @public
1349
+ */
1350
+ hasChallenge?: boolean | undefined;
1351
+ /**
1352
+ * <p>Indicates whether the bot is currently suspended.</p>
1353
+ * @public
1354
+ */
1355
+ suspended?: boolean | undefined;
1356
+ /**
1357
+ * <p>The timestamp of the bot's last login.</p>
1358
+ * @public
1359
+ */
1360
+ lastLogin?: string | undefined;
1361
+ }
1362
+ /**
1363
+ * @public
1364
+ */
1365
+ export interface GetBotsCountRequest {
1366
+ /**
1367
+ * <p>The ID of the Wickr network for which to retrieve bot counts.</p>
1368
+ * @public
1369
+ */
1370
+ networkId: string | undefined;
1371
+ }
1372
+ /**
1373
+ * @public
1374
+ */
1375
+ export interface GetBotsCountResponse {
1376
+ /**
1377
+ * <p>The number of bots with pending status (invited but not yet activated).</p>
1378
+ * @public
1379
+ */
1380
+ pending: number | undefined;
1381
+ /**
1382
+ * <p>The number of bots with active status.</p>
1383
+ * @public
1384
+ */
1385
+ active: number | undefined;
1386
+ /**
1387
+ * <p>The total number of bots in the network (active and pending).</p>
1388
+ * @public
1389
+ */
1390
+ total: number | undefined;
1391
+ }
1392
+ /**
1393
+ * @public
1394
+ */
1395
+ export interface GetDataRetentionBotRequest {
1396
+ /**
1397
+ * <p>The ID of the Wickr network containing the data retention bot.</p>
1398
+ * @public
1399
+ */
1400
+ networkId: string | undefined;
1401
+ }
1402
+ /**
1403
+ * @public
1404
+ */
1405
+ export interface GetDataRetentionBotResponse {
1406
+ /**
1407
+ * <p>The name of the data retention bot.</p>
1408
+ * @public
1409
+ */
1410
+ botName?: string | undefined;
1411
+ /**
1412
+ * <p>Indicates whether a data retention bot exists in the network.</p>
1413
+ * @public
1414
+ */
1415
+ botExists?: boolean | undefined;
1416
+ /**
1417
+ * <p>Indicates whether the data retention bot is active and operational.</p>
1418
+ * @public
1419
+ */
1420
+ isBotActive?: boolean | undefined;
1421
+ /**
1422
+ * <p>Indicates whether the data retention bot has been registered with the network.</p>
1423
+ * @public
1424
+ */
1425
+ isDataRetentionBotRegistered?: boolean | undefined;
1426
+ /**
1427
+ * <p>Indicates whether the data retention service is enabled for the network.</p>
1428
+ * @public
1429
+ */
1430
+ isDataRetentionServiceEnabled?: boolean | undefined;
1431
+ /**
1432
+ * <p>Indicates whether the public key message has been acknowledged by the bot.</p>
1433
+ * @public
1434
+ */
1435
+ isPubkeyMsgAcked?: boolean | undefined;
1436
+ }
1437
+ /**
1438
+ * @public
1439
+ */
1440
+ export interface GetGuestUserHistoryCountRequest {
1441
+ /**
1442
+ * <p>The ID of the Wickr network for which to retrieve guest user history.</p>
1443
+ * @public
1444
+ */
1445
+ networkId: string | undefined;
1446
+ }
1447
+ /**
1448
+ * <p>Contains the count of guest users for a specific billing period, used for tracking historical guest user activity.</p>
1449
+ * @public
1450
+ */
1451
+ export interface GuestUserHistoryCount {
1452
+ /**
1453
+ * <p>The month and billing period in YYYY_MM format (e.g., '2024_01').</p>
1454
+ * @public
1455
+ */
1456
+ month: string | undefined;
1457
+ /**
1458
+ * <p>The number of guest users who have communicated with your Wickr network during this billing period.</p>
1459
+ * @public
1460
+ */
1461
+ count: string | undefined;
1462
+ }
1463
+ /**
1464
+ * @public
1465
+ */
1466
+ export interface GetGuestUserHistoryCountResponse {
1467
+ /**
1468
+ * <p>A list of historical guest user counts, organized by month and billing period.</p>
1469
+ * @public
1470
+ */
1471
+ history: GuestUserHistoryCount[] | undefined;
1472
+ }
1473
+ /**
1474
+ * @public
1475
+ */
1476
+ export interface GetNetworkRequest {
1477
+ /**
1478
+ * <p>The ID of the Wickr network to retrieve.</p>
1479
+ * @public
1480
+ */
1481
+ networkId: string | undefined;
1482
+ }
1483
+ /**
1484
+ * @public
1485
+ */
1486
+ export interface GetNetworkResponse {
1487
+ /**
1488
+ * <p>The unique identifier of the network.</p>
1489
+ * @public
1490
+ */
1491
+ networkId: string | undefined;
1492
+ /**
1493
+ * <p>The name of the network.</p>
1494
+ * @public
1495
+ */
1496
+ networkName: string | undefined;
1497
+ /**
1498
+ * <p>The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.</p>
1499
+ * @public
1500
+ */
1501
+ accessLevel: AccessLevel | undefined;
1502
+ /**
1503
+ * <p>The Amazon Web Services account ID that owns the network.</p>
1504
+ * @public
1505
+ */
1506
+ awsAccountId: string | undefined;
1507
+ /**
1508
+ * <p>The Amazon Resource Name (ARN) of the network.</p>
1509
+ * @public
1510
+ */
1511
+ networkArn: string | undefined;
1512
+ /**
1513
+ * <p>The current standing or status of the network.</p>
1514
+ * @public
1515
+ */
1516
+ standing?: number | undefined;
1517
+ /**
1518
+ * <p>The expiration date and time for the network's free trial period, if applicable.</p>
1519
+ * @public
1520
+ */
1521
+ freeTrialExpiration?: string | undefined;
1522
+ /**
1523
+ * <p>The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).</p>
1524
+ * @public
1525
+ */
1526
+ migrationState?: number | undefined;
1527
+ /**
1528
+ * <p>The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.</p>
1529
+ * @public
1530
+ */
1531
+ encryptionKeyArn?: string | undefined;
1532
+ }
1533
+ /**
1534
+ * @public
1535
+ */
1536
+ export interface GetNetworkSettingsRequest {
1537
+ /**
1538
+ * <p>The ID of the Wickr network whose settings will be retrieved.</p>
1539
+ * @public
1540
+ */
1541
+ networkId: string | undefined;
1542
+ }
1543
+ /**
1544
+ * <p>Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.</p>
1545
+ * @public
1546
+ */
1547
+ export interface Setting {
1548
+ /**
1549
+ * <p>The name of the network setting (e.g., 'enableClientMetrics', 'dataRetention').</p>
1550
+ * @public
1551
+ */
1552
+ optionName: string | undefined;
1553
+ /**
1554
+ * <p>The current value of the setting as a string. Boolean values are represented as 'true' or 'false'.</p>
1555
+ * @public
1556
+ */
1557
+ value: string | undefined;
1558
+ /**
1559
+ * <p>The data type of the setting value (e.g., 'boolean', 'string', 'number').</p>
1560
+ * @public
1561
+ */
1562
+ type: string | undefined;
1563
+ }
1564
+ /**
1565
+ * @public
1566
+ */
1567
+ export interface GetNetworkSettingsResponse {
1568
+ /**
1569
+ * <p>A list of network settings, where each setting includes a name, value, and type.</p>
1570
+ * @public
1571
+ */
1572
+ settings: Setting[] | undefined;
1573
+ }
1574
+ /**
1575
+ * @public
1576
+ */
1577
+ export interface GetOidcInfoRequest {
1578
+ /**
1579
+ * <p>The ID of the Wickr network whose OIDC configuration will be retrieved.</p>
1580
+ * @public
1581
+ */
1582
+ networkId: string | undefined;
1583
+ /**
1584
+ * <p>The OAuth client ID for retrieving access tokens (optional).</p>
1585
+ * @public
1586
+ */
1587
+ clientId?: string | undefined;
1588
+ /**
1589
+ * <p>The authorization code for retrieving access tokens (optional).</p>
1590
+ * @public
1591
+ */
1592
+ code?: string | undefined;
1593
+ /**
1594
+ * <p>The OAuth grant type for retrieving access tokens (optional).</p>
1595
+ * @public
1596
+ */
1597
+ grantType?: string | undefined;
1598
+ /**
1599
+ * <p>The redirect URI for the OAuth flow (optional).</p>
1600
+ * @public
1601
+ */
1602
+ redirectUri?: string | undefined;
1603
+ /**
1604
+ * <p>The URL for the OIDC provider (optional).</p>
1605
+ * @public
1606
+ */
1607
+ url?: string | undefined;
1608
+ /**
1609
+ * <p>The OAuth client secret for retrieving access tokens (optional).</p>
1610
+ * @public
1611
+ */
1612
+ clientSecret?: string | undefined;
1613
+ /**
1614
+ * <p>The PKCE code verifier for enhanced security in the OAuth flow (optional).</p>
1615
+ * @public
1616
+ */
1617
+ codeVerifier?: string | undefined;
1618
+ /**
1619
+ * <p>The CA certificate for secure communication with the OIDC provider (optional).</p>
1620
+ * @public
1621
+ */
1622
+ certificate?: string | undefined;
1623
+ }
1624
+ /**
1625
+ * <p>Contains the OpenID Connect (OIDC) configuration information for Single Sign-On (SSO) authentication, including identity provider settings and client credentials.</p>
1626
+ * @public
1627
+ */
1628
+ export interface OidcConfigInfo {
1629
+ /**
1630
+ * <p>The name of the OIDC application as registered with the identity provider.</p>
1631
+ * @public
1632
+ */
1633
+ applicationName?: string | undefined;
1634
+ /**
1635
+ * <p>The OAuth client ID assigned by the identity provider for authentication requests.</p>
1636
+ * @public
1637
+ */
1638
+ clientId?: string | undefined;
1639
+ /**
1640
+ * <p>Custom identifier your end users will use to sign in with SSO.</p>
1641
+ * @public
1642
+ */
1643
+ companyId: string | undefined;
1644
+ /**
1645
+ * <p>The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').</p>
1646
+ * @public
1647
+ */
1648
+ scopes: string | undefined;
1649
+ /**
1650
+ * <p>The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.</p>
1651
+ * @public
1652
+ */
1653
+ issuer: string | undefined;
1654
+ /**
1655
+ * <p>The OAuth client secret used to authenticate the application with the identity provider.</p>
1656
+ * @public
1657
+ */
1658
+ clientSecret?: string | undefined;
1659
+ /**
1660
+ * <p>An additional secret credential used by the identity provider for authentication.</p>
1661
+ * @public
1662
+ */
1663
+ secret?: string | undefined;
1664
+ /**
1665
+ * <p>The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.</p>
1666
+ * @public
1667
+ */
1668
+ redirectUrl?: string | undefined;
1669
+ /**
1670
+ * <p>The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).</p>
1671
+ * @public
1672
+ */
1673
+ userId?: string | undefined;
1674
+ /**
1675
+ * <p>A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.</p>
1676
+ * @public
1677
+ */
1678
+ customUsername?: string | undefined;
1679
+ /**
1680
+ * <p>The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.</p>
1681
+ * @public
1682
+ */
1683
+ caCertificate?: string | undefined;
1684
+ /**
1685
+ * <p>The unique identifier for the registered OIDC application. Valid range is 1-10.</p>
1686
+ * @public
1687
+ */
1688
+ applicationId?: number | undefined;
1689
+ /**
1690
+ * <p>The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.</p>
1691
+ * @public
1692
+ */
1693
+ ssoTokenBufferMinutes?: number | undefined;
1694
+ /**
1695
+ * <p>Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.</p>
1696
+ * @public
1697
+ */
1698
+ extraAuthParams?: string | undefined;
1699
+ }
1700
+ /**
1701
+ * <p>Contains OAuth token information returned from the identity provider, including access tokens, ID tokens, and PKCE parameters used for secure authentication.</p>
1702
+ * @public
1703
+ */
1704
+ export interface OidcTokenInfo {
1705
+ /**
1706
+ * <p>The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.</p>
1707
+ * @public
1708
+ */
1709
+ codeVerifier?: string | undefined;
1710
+ /**
1711
+ * <p>The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.</p>
1712
+ * @public
1713
+ */
1714
+ codeChallenge?: string | undefined;
1715
+ /**
1716
+ * <p>The OAuth access token that can be used to access protected resources on behalf of the authenticated user.</p>
1717
+ * @public
1718
+ */
1719
+ accessToken?: string | undefined;
1720
+ /**
1721
+ * <p>The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.</p>
1722
+ * @public
1723
+ */
1724
+ idToken?: string | undefined;
1725
+ /**
1726
+ * <p>The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.</p>
1727
+ * @public
1728
+ */
1729
+ refreshToken?: string | undefined;
1730
+ /**
1731
+ * <p>The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.</p>
1732
+ * @public
1733
+ */
1734
+ tokenType?: string | undefined;
1735
+ /**
1736
+ * <p>The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.</p>
1737
+ * @public
1738
+ */
1739
+ expiresIn?: number | undefined;
1740
+ }
1741
+ /**
1742
+ * @public
1743
+ */
1744
+ export interface GetOidcInfoResponse {
1745
+ /**
1746
+ * <p>The OpenID Connect configuration information for the network, including issuer, client ID, scopes, and other SSO settings.</p>
1747
+ * @public
1748
+ */
1749
+ openidConnectInfo?: OidcConfigInfo | undefined;
1750
+ /**
1751
+ * <p>OAuth token information including access token, refresh token, and expiration details (only present if token parameters were provided in the request).</p>
1752
+ * @public
1753
+ */
1754
+ tokenInfo?: OidcTokenInfo | undefined;
1755
+ }
1756
+ /**
1757
+ * @public
1758
+ */
1759
+ export interface GetSecurityGroupRequest {
1760
+ /**
1761
+ * <p>The ID of the Wickr network containing the security group.</p>
1762
+ * @public
1763
+ */
1764
+ networkId: string | undefined;
1765
+ /**
1766
+ * <p>The unique identifier of the security group to retrieve.</p>
1767
+ * @public
1768
+ */
1769
+ groupId: string | undefined;
1770
+ }
1771
+ /**
1772
+ * @public
1773
+ */
1774
+ export interface GetSecurityGroupResponse {
1775
+ /**
1776
+ * <p>The detailed information about the security group, including all its settings and member counts.</p>
1777
+ * @public
1778
+ */
1779
+ securityGroup: SecurityGroup | undefined;
1780
+ }
1781
+ /**
1782
+ * @public
1783
+ */
1784
+ export interface GetUserRequest {
1785
+ /**
1786
+ * <p>The ID of the Wickr network containing the user.</p>
1787
+ * @public
1788
+ */
1789
+ networkId: string | undefined;
1790
+ /**
1791
+ * <p>The unique identifier of the user to retrieve.</p>
1792
+ * @public
1793
+ */
1794
+ userId: string | undefined;
1795
+ /**
1796
+ * <p>The start time for filtering the user's last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.</p>
1797
+ * @public
1798
+ */
1799
+ startTime?: Date | undefined;
1800
+ /**
1801
+ * <p>The end time for filtering the user's last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.</p>
1802
+ * @public
1803
+ */
1804
+ endTime?: Date | undefined;
1805
+ }
1806
+ /**
1807
+ * @public
1808
+ */
1809
+ export interface GetUserResponse {
1810
+ /**
1811
+ * <p>The unique identifier of the user.</p>
1812
+ * @public
1813
+ */
1814
+ userId: string | undefined;
1815
+ /**
1816
+ * <p>The first name of the user.</p>
1817
+ * @public
1818
+ */
1819
+ firstName?: string | undefined;
1820
+ /**
1821
+ * <p>The last name of the user.</p>
1822
+ * @public
1823
+ */
1824
+ lastName?: string | undefined;
1825
+ /**
1826
+ * <p>The email address or username of the user.</p>
1827
+ * @public
1828
+ */
1829
+ username?: string | undefined;
1830
+ /**
1831
+ * <p>Indicates whether the user has administrator privileges in the network.</p>
1832
+ * @public
1833
+ */
1834
+ isAdmin?: boolean | undefined;
1835
+ /**
1836
+ * <p>Indicates whether the user is currently suspended.</p>
1837
+ * @public
1838
+ */
1839
+ suspended?: boolean | undefined;
1840
+ /**
1841
+ * <p>The current status of the user (1 for pending, 2 for active).</p>
1842
+ * @public
1843
+ */
1844
+ status?: number | undefined;
1845
+ /**
1846
+ * <p>The timestamp of the user's last activity in the network, specified in epoch seconds.</p>
1847
+ * @public
1848
+ */
1849
+ lastActivity?: number | undefined;
1850
+ /**
1851
+ * <p>The timestamp of the user's last login to the network, specified in epoch seconds.</p>
1852
+ * @public
1853
+ */
1854
+ lastLogin?: number | undefined;
1855
+ /**
1856
+ * <p>A list of security group IDs to which the user belongs.</p>
1857
+ * @public
1858
+ */
1859
+ securityGroupIds?: string[] | undefined;
1860
+ }
1861
+ /**
1862
+ * @public
1863
+ */
1864
+ export interface GetUsersCountRequest {
1865
+ /**
1866
+ * <p>The ID of the Wickr network for which to retrieve user counts.</p>
1867
+ * @public
1868
+ */
1869
+ networkId: string | undefined;
1870
+ }
1871
+ /**
1872
+ * @public
1873
+ */
1874
+ export interface GetUsersCountResponse {
1875
+ /**
1876
+ * <p>The number of users with pending status (invited but not yet accepted).</p>
1877
+ * @public
1878
+ */
1879
+ pending: number | undefined;
1880
+ /**
1881
+ * <p>The number of users with active status in the network.</p>
1882
+ * @public
1883
+ */
1884
+ active: number | undefined;
1885
+ /**
1886
+ * <p>The number of users who have rejected network invitations.</p>
1887
+ * @public
1888
+ */
1889
+ rejected: number | undefined;
1890
+ /**
1891
+ * <p>The number of additional users that can be added to the network while maintaining premium free trial eligibility.</p>
1892
+ * @public
1893
+ */
1894
+ remaining: number | undefined;
1895
+ /**
1896
+ * <p>The total number of users in the network (active and pending combined).</p>
1897
+ * @public
1898
+ */
1899
+ total: number | undefined;
1900
+ }
1901
+ /**
1902
+ * <p>Represents a guest user who has accessed the network from a federated Wickr network.</p>
1903
+ * @public
1904
+ */
1905
+ export interface GuestUser {
1906
+ /**
1907
+ * <p>The billing period when this guest user accessed the network (e.g., '2024-01').</p>
1908
+ * @public
1909
+ */
1910
+ billingPeriod: string | undefined;
1911
+ /**
1912
+ * <p>The username of the guest user.</p>
1913
+ * @public
1914
+ */
1915
+ username: string | undefined;
1916
+ /**
1917
+ * <p>The unique username hash identifier for the guest user.</p>
1918
+ * @public
1919
+ */
1920
+ usernameHash: string | undefined;
1921
+ }
1922
+ /**
1923
+ * @public
1924
+ */
1925
+ export interface ListBlockedGuestUsersRequest {
1926
+ /**
1927
+ * <p>The ID of the Wickr network from which to list blocked guest users.</p>
1928
+ * @public
1929
+ */
1930
+ networkId: string | undefined;
1931
+ /**
1932
+ * <p>The maximum number of blocked guest users to return in a single page. Valid range is 1-100. Default is 10.</p>
1933
+ * @public
1934
+ */
1935
+ maxResults?: number | undefined;
1936
+ /**
1937
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
1938
+ * @public
1939
+ */
1940
+ sortDirection?: SortDirection | undefined;
1941
+ /**
1942
+ * <p>The field to sort blocked guest users by. Accepted values include 'username', 'admin', and 'modified'.</p>
1943
+ * @public
1944
+ */
1945
+ sortFields?: string | undefined;
1946
+ /**
1947
+ * <p>Filter results to only include blocked guest users with usernames matching this value.</p>
1948
+ * @public
1949
+ */
1950
+ username?: string | undefined;
1951
+ /**
1952
+ * <p>Filter results to only include blocked guest users that were blocked by this administrator.</p>
1953
+ * @public
1954
+ */
1955
+ admin?: string | undefined;
1956
+ /**
1957
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
1958
+ * @public
1959
+ */
1960
+ nextToken?: string | undefined;
1961
+ }
1962
+ /**
1963
+ * @public
1964
+ */
1965
+ export interface ListBlockedGuestUsersResponse {
1966
+ /**
1967
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
1968
+ * @public
1969
+ */
1970
+ nextToken?: string | undefined;
1971
+ /**
1972
+ * <p>A list of blocked guest user objects within the current page.</p>
1973
+ * @public
1974
+ */
1975
+ blocklist: BlockedGuestUser[] | undefined;
1976
+ }
1977
+ /**
1978
+ * @public
1979
+ */
1980
+ export interface ListBotsRequest {
1981
+ /**
1982
+ * <p>The ID of the Wickr network from which to list bots.</p>
1983
+ * @public
1984
+ */
1985
+ networkId: string | undefined;
1986
+ /**
1987
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
1988
+ * @public
1989
+ */
1990
+ nextToken?: string | undefined;
1991
+ /**
1992
+ * <p>The maximum number of bots to return in a single page. Valid range is 1-100. Default is 10.</p>
1993
+ * @public
1994
+ */
1995
+ maxResults?: number | undefined;
1996
+ /**
1997
+ * <p>The fields to sort bots by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'displayName', 'status', and 'groupId'.</p>
1998
+ * @public
1999
+ */
2000
+ sortFields?: string | undefined;
2001
+ /**
2002
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2003
+ * @public
2004
+ */
2005
+ sortDirection?: SortDirection | undefined;
2006
+ /**
2007
+ * <p>Filter results to only include bots with display names matching this value.</p>
2008
+ * @public
2009
+ */
2010
+ displayName?: string | undefined;
2011
+ /**
2012
+ * <p>Filter results to only include bots with usernames matching this value.</p>
2013
+ * @public
2014
+ */
2015
+ username?: string | undefined;
2016
+ /**
2017
+ * <p>Filter results to only include bots with this status (1 for pending, 2 for active).</p>
2018
+ * @public
2019
+ */
2020
+ status?: BotStatus | undefined;
2021
+ /**
2022
+ * <p>Filter results to only include bots belonging to this security group.</p>
2023
+ * @public
2024
+ */
2025
+ groupId?: string | undefined;
2026
+ }
2027
+ /**
2028
+ * @public
2029
+ */
2030
+ export interface ListBotsResponse {
2031
+ /**
2032
+ * <p>A list of bot objects matching the specified filters and within the current page.</p>
2033
+ * @public
2034
+ */
2035
+ bots: Bot[] | undefined;
2036
+ /**
2037
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2038
+ * @public
2039
+ */
2040
+ nextToken?: string | undefined;
2041
+ }
2042
+ /**
2043
+ * @public
2044
+ */
2045
+ export interface ListDevicesForUserRequest {
2046
+ /**
2047
+ * <p>The ID of the Wickr network containing the user.</p>
2048
+ * @public
2049
+ */
2050
+ networkId: string | undefined;
2051
+ /**
2052
+ * <p>The unique identifier of the user whose devices will be listed.</p>
2053
+ * @public
2054
+ */
2055
+ userId: string | undefined;
2056
+ /**
2057
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
2058
+ * @public
2059
+ */
2060
+ nextToken?: string | undefined;
2061
+ /**
2062
+ * <p>The maximum number of devices to return in a single page. Valid range is 1-100. Default is 10.</p>
2063
+ * @public
2064
+ */
2065
+ maxResults?: number | undefined;
2066
+ /**
2067
+ * <p>The fields to sort devices by. Multiple fields can be specified by separating them with '+'. Accepted values include 'lastlogin', 'type', 'suspend', and 'created'.</p>
2068
+ * @public
2069
+ */
2070
+ sortFields?: string | undefined;
2071
+ /**
2072
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2073
+ * @public
2074
+ */
2075
+ sortDirection?: SortDirection | undefined;
2076
+ }
2077
+ /**
2078
+ * @public
2079
+ */
2080
+ export interface ListDevicesForUserResponse {
2081
+ /**
2082
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2083
+ * @public
2084
+ */
2085
+ nextToken?: string | undefined;
2086
+ /**
2087
+ * <p>A list of device objects associated with the user within the current page.</p>
2088
+ * @public
2089
+ */
2090
+ devices: BasicDeviceObject[] | undefined;
2091
+ }
2092
+ /**
2093
+ * @public
2094
+ */
2095
+ export interface ListGuestUsersRequest {
2096
+ /**
2097
+ * <p>The ID of the Wickr network from which to list guest users.</p>
2098
+ * @public
2099
+ */
2100
+ networkId: string | undefined;
2101
+ /**
2102
+ * <p>The maximum number of guest users to return in a single page. Valid range is 1-100. Default is 10.</p>
2103
+ * @public
2104
+ */
2105
+ maxResults?: number | undefined;
2106
+ /**
2107
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2108
+ * @public
2109
+ */
2110
+ sortDirection?: SortDirection | undefined;
2111
+ /**
2112
+ * <p>The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.</p>
2113
+ * @public
2114
+ */
2115
+ sortFields?: string | undefined;
2116
+ /**
2117
+ * <p>Filter results to only include guest users with usernames matching this value.</p>
2118
+ * @public
2119
+ */
2120
+ username?: string | undefined;
2121
+ /**
2122
+ * <p>Filter results to only include guest users from this billing period (e.g., '2024-01').</p>
2123
+ * @public
2124
+ */
2125
+ billingPeriod?: string | undefined;
2126
+ /**
2127
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
2128
+ * @public
2129
+ */
2130
+ nextToken?: string | undefined;
2131
+ }
2132
+ /**
2133
+ * @public
2134
+ */
2135
+ export interface ListGuestUsersResponse {
2136
+ /**
2137
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2138
+ * @public
2139
+ */
2140
+ nextToken?: string | undefined;
2141
+ /**
2142
+ * <p>A list of guest user objects within the current page.</p>
2143
+ * @public
2144
+ */
2145
+ guestlist: GuestUser[] | undefined;
2146
+ }
2147
+ /**
2148
+ * @public
2149
+ */
2150
+ export interface ListNetworksRequest {
2151
+ /**
2152
+ * <p>The maximum number of networks to return in a single page. Valid range is 1-100. Default is 10.</p>
2153
+ * @public
2154
+ */
2155
+ maxResults?: number | undefined;
2156
+ /**
2157
+ * <p>The field to sort networks by. Accepted values are 'networkId' and 'networkName'. Default is 'networkId'.</p>
2158
+ * @public
2159
+ */
2160
+ sortFields?: string | undefined;
2161
+ /**
2162
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2163
+ * @public
2164
+ */
2165
+ sortDirection?: SortDirection | undefined;
2166
+ /**
2167
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
2168
+ * @public
2169
+ */
2170
+ nextToken?: string | undefined;
2171
+ }
2172
+ /**
2173
+ * <p>Represents a Wickr network with all its configuration and status information.</p>
2174
+ * @public
2175
+ */
2176
+ export interface Network {
2177
+ /**
2178
+ * <p>The unique identifier of the network.</p>
2179
+ * @public
2180
+ */
2181
+ networkId: string | undefined;
2182
+ /**
2183
+ * <p>The name of the network.</p>
2184
+ * @public
2185
+ */
2186
+ networkName: string | undefined;
2187
+ /**
2188
+ * <p>The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.</p>
2189
+ * @public
2190
+ */
2191
+ accessLevel: AccessLevel | undefined;
2192
+ /**
2193
+ * <p>The Amazon Web Services account ID that owns the network.</p>
2194
+ * @public
2195
+ */
2196
+ awsAccountId: string | undefined;
2197
+ /**
2198
+ * <p>The Amazon Resource Name (ARN) of the network.</p>
2199
+ * @public
2200
+ */
2201
+ networkArn: string | undefined;
2202
+ /**
2203
+ * <p>The current standing or status of the network.</p>
2204
+ * @public
2205
+ */
2206
+ standing?: number | undefined;
2207
+ /**
2208
+ * <p>The expiration date and time for the network's free trial period, if applicable.</p>
2209
+ * @public
2210
+ */
2211
+ freeTrialExpiration?: string | undefined;
2212
+ /**
2213
+ * <p>The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).</p>
2214
+ * @public
2215
+ */
2216
+ migrationState?: number | undefined;
2217
+ /**
2218
+ * <p>The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.</p>
2219
+ * @public
2220
+ */
2221
+ encryptionKeyArn?: string | undefined;
2222
+ }
2223
+ /**
2224
+ * @public
2225
+ */
2226
+ export interface ListNetworksResponse {
2227
+ /**
2228
+ * <p>A list of network objects for the Amazon Web Services account.</p>
2229
+ * @public
2230
+ */
2231
+ networks: Network[] | undefined;
2232
+ /**
2233
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2234
+ * @public
2235
+ */
2236
+ nextToken?: string | undefined;
2237
+ }
2238
+ /**
2239
+ * @public
2240
+ */
2241
+ export interface ListSecurityGroupsRequest {
2242
+ /**
2243
+ * <p>The ID of the Wickr network from which to list security groups.</p>
2244
+ * @public
2245
+ */
2246
+ networkId: string | undefined;
2247
+ /**
2248
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
2249
+ * @public
2250
+ */
2251
+ nextToken?: string | undefined;
2252
+ /**
2253
+ * <p>The maximum number of security groups to return in a single page. Valid range is 1-100. Default is 10.</p>
2254
+ * @public
2255
+ */
2256
+ maxResults?: number | undefined;
2257
+ /**
2258
+ * <p>The field to sort security groups by. Accepted values include 'id' and 'name'.</p>
2259
+ * @public
2260
+ */
2261
+ sortFields?: string | undefined;
2262
+ /**
2263
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2264
+ * @public
2265
+ */
2266
+ sortDirection?: SortDirection | undefined;
2267
+ }
2268
+ /**
2269
+ * @public
2270
+ */
2271
+ export interface ListSecurityGroupsResponse {
2272
+ /**
2273
+ * <p>A list of security group objects in the current page.</p>
2274
+ * @public
2275
+ */
2276
+ securityGroups?: SecurityGroup[] | undefined;
2277
+ /**
2278
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2279
+ * @public
2280
+ */
2281
+ nextToken?: string | undefined;
2282
+ }
2283
+ /**
2284
+ * @public
2285
+ */
2286
+ export interface ListSecurityGroupUsersRequest {
2287
+ /**
2288
+ * <p>The ID of the Wickr network containing the security group.</p>
2289
+ * @public
2290
+ */
2291
+ networkId: string | undefined;
2292
+ /**
2293
+ * <p>The unique identifier of the security group whose users will be listed.</p>
2294
+ * @public
2295
+ */
2296
+ groupId: string | undefined;
2297
+ /**
2298
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
2299
+ * @public
2300
+ */
2301
+ nextToken?: string | undefined;
2302
+ /**
2303
+ * <p>The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.</p>
2304
+ * @public
2305
+ */
2306
+ maxResults?: number | undefined;
2307
+ /**
2308
+ * <p>The field to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', and 'lastName'.</p>
2309
+ * @public
2310
+ */
2311
+ sortFields?: string | undefined;
2312
+ /**
2313
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2314
+ * @public
2315
+ */
2316
+ sortDirection?: SortDirection | undefined;
2317
+ }
2318
+ /**
2319
+ * @public
2320
+ */
2321
+ export interface ListSecurityGroupUsersResponse {
2322
+ /**
2323
+ * <p>A list of user objects belonging to the security group within the current page.</p>
2324
+ * @public
2325
+ */
2326
+ users: User[] | undefined;
2327
+ /**
2328
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2329
+ * @public
2330
+ */
2331
+ nextToken?: string | undefined;
2332
+ }
2333
+ /**
2334
+ * @public
2335
+ */
2336
+ export interface ListUsersRequest {
2337
+ /**
2338
+ * <p>The ID of the Wickr network from which to list users.</p>
2339
+ * @public
2340
+ */
2341
+ networkId: string | undefined;
2342
+ /**
2343
+ * <p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>
2344
+ * @public
2345
+ */
2346
+ nextToken?: string | undefined;
2347
+ /**
2348
+ * <p>The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.</p>
2349
+ * @public
2350
+ */
2351
+ maxResults?: number | undefined;
2352
+ /**
2353
+ * <p>The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.</p>
2354
+ * @public
2355
+ */
2356
+ sortFields?: string | undefined;
2357
+ /**
2358
+ * <p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>
2359
+ * @public
2360
+ */
2361
+ sortDirection?: SortDirection | undefined;
2362
+ /**
2363
+ * <p>Filter results to only include users with first names matching this value.</p>
2364
+ * @public
2365
+ */
2366
+ firstName?: string | undefined;
2367
+ /**
2368
+ * <p>Filter results to only include users with last names matching this value.</p>
2369
+ * @public
2370
+ */
2371
+ lastName?: string | undefined;
2372
+ /**
2373
+ * <p>Filter results to only include users with usernames matching this value.</p>
2374
+ * @public
2375
+ */
2376
+ username?: string | undefined;
2377
+ /**
2378
+ * <p>Filter results to only include users with this status (1 for pending, 2 for active).</p>
2379
+ * @public
2380
+ */
2381
+ status?: UserStatus | undefined;
2382
+ /**
2383
+ * <p>Filter results to only include users belonging to this security group.</p>
2384
+ * @public
2385
+ */
2386
+ groupId?: string | undefined;
2387
+ }
2388
+ /**
2389
+ * @public
2390
+ */
2391
+ export interface ListUsersResponse {
2392
+ /**
2393
+ * <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
2394
+ * @public
2395
+ */
2396
+ nextToken?: string | undefined;
2397
+ /**
2398
+ * <p>A list of user objects matching the specified filters and within the current page.</p>
2399
+ * @public
2400
+ */
2401
+ users?: User[] | undefined;
2402
+ }
2403
+ /**
2404
+ * <p>Configuration for read receipts at the network level, controlling whether senders can see when their messages have been read.</p>
2405
+ * @public
2406
+ */
2407
+ export interface ReadReceiptConfig {
2408
+ /**
2409
+ * <p>The read receipt status mode for the network.</p>
2410
+ * @public
2411
+ */
2412
+ status?: Status | undefined;
2413
+ }
2414
+ /**
2415
+ * <p>Contains network-level configuration settings that apply to all users and security groups within a Wickr network.</p>
2416
+ * @public
2417
+ */
2418
+ export interface NetworkSettings {
2419
+ /**
2420
+ * <p>Allows Wickr clients to send anonymized performance and usage metrics to the Wickr backend server for service improvement and troubleshooting.</p>
2421
+ * @public
2422
+ */
2423
+ enableClientMetrics?: boolean | undefined;
2424
+ /**
2425
+ * <p>Configuration for read receipts at the network level, controlling the default behavior for whether senders can see when their messages have been read.</p>
2426
+ * @public
2427
+ */
2428
+ readReceiptConfig?: ReadReceiptConfig | undefined;
2429
+ /**
2430
+ * <p>Indicates whether the data retention feature is enabled for the network. When true, messages are captured by the data retention bot for compliance and archiving purposes.</p>
2431
+ * @public
2432
+ */
2433
+ dataRetention?: boolean | undefined;
2434
+ }
2435
+ /**
2436
+ * @public
2437
+ */
2438
+ export interface RegisterOidcConfigRequest {
2439
+ /**
2440
+ * <p>The ID of the Wickr network for which OIDC will be configured.</p>
2441
+ * @public
2442
+ */
2443
+ networkId: string | undefined;
2444
+ /**
2445
+ * <p>Custom identifier your end users will use to sign in with SSO.</p>
2446
+ * @public
2447
+ */
2448
+ companyId: string | undefined;
2449
+ /**
2450
+ * <p>A custom field mapping to extract the username from the OIDC token (optional). </p> <note> <p>The customUsername is only required if you use something other than email as the username field.</p> </note>
2451
+ * @public
2452
+ */
2453
+ customUsername?: string | undefined;
2454
+ /**
2455
+ * <p>Additional authentication parameters to include in the OIDC flow (optional).</p>
2456
+ * @public
2457
+ */
2458
+ extraAuthParams?: string | undefined;
2459
+ /**
2460
+ * <p>The issuer URL of the OIDC provider (e.g., 'https://login.example.com').</p>
2461
+ * @public
2462
+ */
2463
+ issuer: string | undefined;
2464
+ /**
2465
+ * <p>The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').</p>
2466
+ * @public
2467
+ */
2468
+ scopes: string | undefined;
2469
+ /**
2470
+ * <p>The client secret for authenticating with the OIDC provider (optional).</p>
2471
+ * @public
2472
+ */
2473
+ secret?: string | undefined;
2474
+ /**
2475
+ * <p>The buffer time in minutes before the SSO token expires to refresh it (optional).</p>
2476
+ * @public
2477
+ */
2478
+ ssoTokenBufferMinutes?: number | undefined;
2479
+ /**
2480
+ * <p>Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.</p>
2481
+ * @public
2482
+ */
2483
+ userId?: string | undefined;
2484
+ }
2485
+ /**
2486
+ * @public
2487
+ */
2488
+ export interface RegisterOidcConfigResponse {
2489
+ /**
2490
+ * <p>The name of the registered OIDC application.</p>
2491
+ * @public
2492
+ */
2493
+ applicationName?: string | undefined;
2494
+ /**
2495
+ * <p>The OAuth client ID assigned to the application.</p>
2496
+ * @public
2497
+ */
2498
+ clientId?: string | undefined;
2499
+ /**
2500
+ * <p>Custom identifier your end users will use to sign in with SSO.</p>
2501
+ * @public
2502
+ */
2503
+ companyId: string | undefined;
2504
+ /**
2505
+ * <p>The OAuth scopes configured for the application.</p>
2506
+ * @public
2507
+ */
2508
+ scopes: string | undefined;
2509
+ /**
2510
+ * <p>The issuer URL of the OIDC provider.</p>
2511
+ * @public
2512
+ */
2513
+ issuer: string | undefined;
2514
+ /**
2515
+ * <p>The OAuth client secret for the application.</p>
2516
+ * @public
2517
+ */
2518
+ clientSecret?: string | undefined;
2519
+ /**
2520
+ * <p>The client secret for authenticating with the OIDC provider.</p>
2521
+ * @public
2522
+ */
2523
+ secret?: string | undefined;
2524
+ /**
2525
+ * <p>The redirect URL configured for the OAuth flow.</p>
2526
+ * @public
2527
+ */
2528
+ redirectUrl?: string | undefined;
2529
+ /**
2530
+ * <p>The claim field being used as the user identifier.</p>
2531
+ * @public
2532
+ */
2533
+ userId?: string | undefined;
2534
+ /**
2535
+ * <p>The custom field mapping used for extracting the username.</p>
2536
+ * @public
2537
+ */
2538
+ customUsername?: string | undefined;
2539
+ /**
2540
+ * <p>The CA certificate used for secure communication with the OIDC provider.</p>
2541
+ * @public
2542
+ */
2543
+ caCertificate?: string | undefined;
2544
+ /**
2545
+ * <p>The unique identifier for the registered OIDC application.</p>
2546
+ * @public
2547
+ */
2548
+ applicationId?: number | undefined;
2549
+ /**
2550
+ * <p>The buffer time in minutes before the SSO token expires.</p>
2551
+ * @public
2552
+ */
2553
+ ssoTokenBufferMinutes?: number | undefined;
2554
+ /**
2555
+ * <p>The additional authentication parameters configured for the OIDC flow.</p>
2556
+ * @public
2557
+ */
2558
+ extraAuthParams?: string | undefined;
2559
+ }
2560
+ /**
2561
+ * @public
2562
+ */
2563
+ export interface RegisterOidcConfigTestRequest {
2564
+ /**
2565
+ * <p>The ID of the Wickr network for which the OIDC configuration will be tested.</p>
2566
+ * @public
2567
+ */
2568
+ networkId: string | undefined;
2569
+ /**
2570
+ * <p>Additional authentication parameters to include in the test (optional).</p>
2571
+ * @public
2572
+ */
2573
+ extraAuthParams?: string | undefined;
2574
+ /**
2575
+ * <p>The issuer URL of the OIDC provider to test.</p>
2576
+ * @public
2577
+ */
2578
+ issuer: string | undefined;
2579
+ /**
2580
+ * <p>The OAuth scopes to test with the OIDC provider.</p>
2581
+ * @public
2582
+ */
2583
+ scopes: string | undefined;
2584
+ /**
2585
+ * <p>The CA certificate for secure communication with the OIDC provider (optional).</p>
2586
+ * @public
2587
+ */
2588
+ certificate?: string | undefined;
2589
+ }
2590
+ /**
2591
+ * @public
2592
+ */
2593
+ export interface RegisterOidcConfigTestResponse {
2594
+ /**
2595
+ * <p>The token endpoint URL discovered from the OIDC provider.</p>
2596
+ * @public
2597
+ */
2598
+ tokenEndpoint?: string | undefined;
2599
+ /**
2600
+ * <p>The user info endpoint URL discovered from the OIDC provider.</p>
2601
+ * @public
2602
+ */
2603
+ userinfoEndpoint?: string | undefined;
2604
+ /**
2605
+ * <p>The OAuth response types supported by the OIDC provider.</p>
2606
+ * @public
2607
+ */
2608
+ responseTypesSupported?: string[] | undefined;
2609
+ /**
2610
+ * <p>The OAuth scopes supported by the OIDC provider.</p>
2611
+ * @public
2612
+ */
2613
+ scopesSupported?: string[] | undefined;
2614
+ /**
2615
+ * <p>The issuer URL confirmed by the OIDC provider.</p>
2616
+ * @public
2617
+ */
2618
+ issuer?: string | undefined;
2619
+ /**
2620
+ * <p>The authorization endpoint URL discovered from the OIDC provider.</p>
2621
+ * @public
2622
+ */
2623
+ authorizationEndpoint?: string | undefined;
2624
+ /**
2625
+ * <p>The end session endpoint URL for logging out users from the OIDC provider.</p>
2626
+ * @public
2627
+ */
2628
+ endSessionEndpoint?: string | undefined;
2629
+ /**
2630
+ * <p>The logout endpoint URL for terminating user sessions.</p>
2631
+ * @public
2632
+ */
2633
+ logoutEndpoint?: string | undefined;
2634
+ /**
2635
+ * <p>The OAuth grant types supported by the OIDC provider.</p>
2636
+ * @public
2637
+ */
2638
+ grantTypesSupported?: string[] | undefined;
2639
+ /**
2640
+ * <p>The token revocation endpoint URL for invalidating tokens.</p>
2641
+ * @public
2642
+ */
2643
+ revocationEndpoint?: string | undefined;
2644
+ /**
2645
+ * <p>The authentication methods supported by the token endpoint.</p>
2646
+ * @public
2647
+ */
2648
+ tokenEndpointAuthMethodsSupported?: string[] | undefined;
2649
+ /**
2650
+ * <p>Indicates whether the provider supports Microsoft multi-refresh tokens.</p>
2651
+ * @public
2652
+ */
2653
+ microsoftMultiRefreshToken?: boolean | undefined;
2654
+ }
2655
+ /**
2656
+ * @public
2657
+ */
2658
+ export interface UpdateBotRequest {
2659
+ /**
2660
+ * <p>The ID of the Wickr network containing the bot to update.</p>
2661
+ * @public
2662
+ */
2663
+ networkId: string | undefined;
2664
+ /**
2665
+ * <p>The unique identifier of the bot to update.</p>
2666
+ * @public
2667
+ */
2668
+ botId: string | undefined;
2669
+ /**
2670
+ * <p>The new display name for the bot.</p>
2671
+ * @public
2672
+ */
2673
+ displayName?: string | undefined;
2674
+ /**
2675
+ * <p>The ID of the new security group to assign the bot to.</p>
2676
+ * @public
2677
+ */
2678
+ groupId?: string | undefined;
2679
+ /**
2680
+ * <p>The new password for the bot account.</p>
2681
+ * @public
2682
+ */
2683
+ challenge?: string | undefined;
2684
+ /**
2685
+ * <p>Set to true to suspend the bot or false to unsuspend it. Omit this field for standard updates that don't affect suspension status.</p>
2686
+ * @public
2687
+ */
2688
+ suspend?: boolean | undefined;
2689
+ }
2690
+ /**
2691
+ * @public
2692
+ */
2693
+ export interface UpdateBotResponse {
2694
+ /**
2695
+ * <p>A message indicating the result of the bot update operation.</p>
2696
+ * @public
2697
+ */
2698
+ message?: string | undefined;
2699
+ }
2700
+ /**
2701
+ * @public
2702
+ */
2703
+ export interface UpdateDataRetentionRequest {
2704
+ /**
2705
+ * <p>The ID of the Wickr network containing the data retention bot.</p>
2706
+ * @public
2707
+ */
2708
+ networkId: string | undefined;
2709
+ /**
2710
+ * <p>The action to perform. Valid values are 'ENABLE' (to enable the data retention service), 'DISABLE' (to disable the service), or 'PUBKEY_MSG_ACK' (to acknowledge the public key message).</p>
2711
+ * @public
2712
+ */
2713
+ actionType: DataRetentionActionType | undefined;
2714
+ }
2715
+ /**
2716
+ * @public
2717
+ */
2718
+ export interface UpdateDataRetentionResponse {
2719
+ /**
2720
+ * <p>A message indicating the result of the update operation.</p>
2721
+ * @public
2722
+ */
2723
+ message?: string | undefined;
2724
+ }
2725
+ /**
2726
+ * @public
2727
+ */
2728
+ export interface UpdateGuestUserRequest {
2729
+ /**
2730
+ * <p>The ID of the Wickr network where the guest user's status will be updated.</p>
2731
+ * @public
2732
+ */
2733
+ networkId: string | undefined;
2734
+ /**
2735
+ * <p>The username hash (unique identifier) of the guest user to update.</p>
2736
+ * @public
2737
+ */
2738
+ usernameHash: string | undefined;
2739
+ /**
2740
+ * <p>Set to true to block the guest user or false to unblock them.</p>
2741
+ * @public
2742
+ */
2743
+ block: boolean | undefined;
2744
+ }
2745
+ /**
2746
+ * @public
2747
+ */
2748
+ export interface UpdateGuestUserResponse {
2749
+ /**
2750
+ * <p>A message indicating the result of the update operation.</p>
2751
+ * @public
2752
+ */
2753
+ message?: string | undefined;
2754
+ }
2755
+ /**
2756
+ * @public
2757
+ */
2758
+ export interface UpdateNetworkRequest {
2759
+ /**
2760
+ * <p>The ID of the Wickr network to update.</p>
2761
+ * @public
2762
+ */
2763
+ networkId: string | undefined;
2764
+ /**
2765
+ * <p>The new name for the network. Must be between 1 and 20 characters.</p>
2766
+ * @public
2767
+ */
2768
+ networkName: string | undefined;
2769
+ /**
2770
+ * <p>A unique identifier for this request to ensure idempotency.</p>
2771
+ * @public
2772
+ */
2773
+ clientToken?: string | undefined;
2774
+ /**
2775
+ * <p>The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.</p>
2776
+ * @public
2777
+ */
2778
+ encryptionKeyArn?: string | undefined;
2779
+ }
2780
+ /**
2781
+ * @public
2782
+ */
2783
+ export interface UpdateNetworkResponse {
2784
+ /**
2785
+ * <p>A message indicating that the network was updated successfully.</p>
2786
+ * @public
2787
+ */
2788
+ message?: string | undefined;
2789
+ }
2790
+ /**
2791
+ * @public
2792
+ */
2793
+ export interface UpdateNetworkSettingsRequest {
2794
+ /**
2795
+ * <p>The ID of the Wickr network whose settings will be updated.</p>
2796
+ * @public
2797
+ */
2798
+ networkId: string | undefined;
2799
+ /**
2800
+ * <p>A map of setting names to their new values. Each setting should be provided with its appropriate type (boolean, string, number, etc.).</p>
2801
+ * @public
2802
+ */
2803
+ settings: NetworkSettings | undefined;
2804
+ }
2805
+ /**
2806
+ * @public
2807
+ */
2808
+ export interface UpdateNetworkSettingsResponse {
2809
+ /**
2810
+ * <p>A list of the updated network settings, showing the new values for each modified setting.</p>
2811
+ * @public
2812
+ */
2813
+ settings: Setting[] | undefined;
2814
+ }
2815
+ /**
2816
+ * @public
2817
+ */
2818
+ export interface UpdateSecurityGroupRequest {
2819
+ /**
2820
+ * <p>The ID of the Wickr network containing the security group to update.</p>
2821
+ * @public
2822
+ */
2823
+ networkId: string | undefined;
2824
+ /**
2825
+ * <p>The unique identifier of the security group to update.</p>
2826
+ * @public
2827
+ */
2828
+ groupId: string | undefined;
2829
+ /**
2830
+ * <p>The new name for the security group.</p>
2831
+ * @public
2832
+ */
2833
+ name?: string | undefined;
2834
+ /**
2835
+ * <p>The updated configuration settings for the security group.</p> <p>Federation mode - 0 (Local federation), 1 (Restricted federation), 2 (Global federation) </p>
2836
+ * @public
2837
+ */
2838
+ securityGroupSettings?: SecurityGroupSettings | undefined;
2839
+ }
2840
+ /**
2841
+ * @public
2842
+ */
2843
+ export interface UpdateSecurityGroupResponse {
2844
+ /**
2845
+ * <p>The updated security group details, including the new settings.</p>
2846
+ * @public
2847
+ */
2848
+ securityGroup: SecurityGroup | undefined;
2849
+ }
2850
+ /**
2851
+ * <p>Contains the modifiable details for updating an existing user, including name, password, security group membership, and invitation settings.</p> <note> <p>A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.</p> </note>
2852
+ * @public
2853
+ */
2854
+ export interface UpdateUserDetails {
2855
+ /**
2856
+ * <p>The new first name for the user.</p>
2857
+ * @public
2858
+ */
2859
+ firstName?: string | undefined;
2860
+ /**
2861
+ * <p>The new last name for the user.</p>
2862
+ * @public
2863
+ */
2864
+ lastName?: string | undefined;
2865
+ /**
2866
+ * <p>The new username or email address for the user.</p>
2867
+ * @public
2868
+ */
2869
+ username?: string | undefined;
2870
+ /**
2871
+ * <p>The updated list of security group IDs to which the user should belong.</p>
2872
+ * @public
2873
+ */
2874
+ securityGroupIds?: string[] | undefined;
2875
+ /**
2876
+ * <p>A new custom invite code for the user.</p>
2877
+ * @public
2878
+ */
2879
+ inviteCode?: string | undefined;
2880
+ /**
2881
+ * <p>The new time-to-live for the invite code in days.</p>
2882
+ * @public
2883
+ */
2884
+ inviteCodeTtl?: number | undefined;
2885
+ /**
2886
+ * <p>Indicates whether the user can be verified through a custom invite code.</p>
2887
+ * @public
2888
+ */
2889
+ codeValidation?: boolean | undefined;
2890
+ }
2891
+ /**
2892
+ * @public
2893
+ */
2894
+ export interface UpdateUserRequest {
2895
+ /**
2896
+ * <p>The ID of the Wickr network containing the user to update.</p>
2897
+ * @public
2898
+ */
2899
+ networkId: string | undefined;
2900
+ /**
2901
+ * <p>The unique identifier of the user to update.</p>
2902
+ * @public
2903
+ */
2904
+ userId: string | undefined;
2905
+ /**
2906
+ * <p>An object containing the user details to be updated, such as name, password, security groups, and invite code settings.</p>
2907
+ * @public
2908
+ */
2909
+ userDetails?: UpdateUserDetails | undefined;
2910
+ }
2911
+ /**
2912
+ * @public
2913
+ */
2914
+ export interface UpdateUserResponse {
2915
+ /**
2916
+ * <p>The unique identifier of the updated user.</p>
2917
+ * @public
2918
+ */
2919
+ userId: string | undefined;
2920
+ /**
2921
+ * <p>The ID of the network where the user was updated.</p>
2922
+ * @public
2923
+ */
2924
+ networkId: string | undefined;
2925
+ /**
2926
+ * <p>The list of security group IDs to which the user now belongs after the update.</p>
2927
+ * @public
2928
+ */
2929
+ securityGroupIds?: string[] | undefined;
2930
+ /**
2931
+ * <p>The updated first name of the user.</p>
2932
+ * @public
2933
+ */
2934
+ firstName?: string | undefined;
2935
+ /**
2936
+ * <p>The updated last name of the user.</p>
2937
+ * @public
2938
+ */
2939
+ lastName?: string | undefined;
2940
+ /**
2941
+ * <p>The middle name of the user (currently not used).</p>
2942
+ * @public
2943
+ */
2944
+ middleName?: string | undefined;
2945
+ /**
2946
+ * <p>Indicates whether the user is suspended after the update.</p>
2947
+ * @public
2948
+ */
2949
+ suspended: boolean | undefined;
2950
+ /**
2951
+ * <p>The timestamp when the user was last modified, specified in epoch seconds.</p>
2952
+ * @public
2953
+ */
2954
+ modified?: number | undefined;
2955
+ /**
2956
+ * <p>The user's status after the update.</p>
2957
+ * @public
2958
+ */
2959
+ status?: number | undefined;
2960
+ /**
2961
+ * <p>The updated invite code for the user, if applicable.</p>
2962
+ * @public
2963
+ */
2964
+ inviteCode?: string | undefined;
2965
+ /**
2966
+ * <p>The expiration time of the user's invite code, specified in epoch seconds.</p>
2967
+ * @public
2968
+ */
2969
+ inviteExpiration?: number | undefined;
2970
+ /**
2971
+ * <p>Indicates whether the user can be verified through a custom invite code.</p>
2972
+ * @public
2973
+ */
2974
+ codeValidation?: boolean | undefined;
2975
+ }