@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.
- package/LICENSE +201 -0
- package/README.md +541 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +2520 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +55 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-es/Wickr.js +91 -0
- package/dist-es/WickrClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/BatchCreateUserCommand.js +16 -0
- package/dist-es/commands/BatchDeleteUserCommand.js +16 -0
- package/dist-es/commands/BatchLookupUserUnameCommand.js +16 -0
- package/dist-es/commands/BatchReinviteUserCommand.js +16 -0
- package/dist-es/commands/BatchResetDevicesForUserCommand.js +16 -0
- package/dist-es/commands/BatchToggleUserSuspendStatusCommand.js +16 -0
- package/dist-es/commands/CreateBotCommand.js +16 -0
- package/dist-es/commands/CreateDataRetentionBotChallengeCommand.js +16 -0
- package/dist-es/commands/CreateDataRetentionBotCommand.js +16 -0
- package/dist-es/commands/CreateNetworkCommand.js +16 -0
- package/dist-es/commands/CreateSecurityGroupCommand.js +16 -0
- package/dist-es/commands/DeleteBotCommand.js +16 -0
- package/dist-es/commands/DeleteDataRetentionBotCommand.js +16 -0
- package/dist-es/commands/DeleteNetworkCommand.js +16 -0
- package/dist-es/commands/DeleteSecurityGroupCommand.js +16 -0
- package/dist-es/commands/GetBotCommand.js +16 -0
- package/dist-es/commands/GetBotsCountCommand.js +16 -0
- package/dist-es/commands/GetDataRetentionBotCommand.js +16 -0
- package/dist-es/commands/GetGuestUserHistoryCountCommand.js +16 -0
- package/dist-es/commands/GetNetworkCommand.js +16 -0
- package/dist-es/commands/GetNetworkSettingsCommand.js +16 -0
- package/dist-es/commands/GetOidcInfoCommand.js +16 -0
- package/dist-es/commands/GetSecurityGroupCommand.js +16 -0
- package/dist-es/commands/GetUserCommand.js +16 -0
- package/dist-es/commands/GetUsersCountCommand.js +16 -0
- package/dist-es/commands/ListBlockedGuestUsersCommand.js +16 -0
- package/dist-es/commands/ListBotsCommand.js +16 -0
- package/dist-es/commands/ListDevicesForUserCommand.js +16 -0
- package/dist-es/commands/ListGuestUsersCommand.js +16 -0
- package/dist-es/commands/ListNetworksCommand.js +16 -0
- package/dist-es/commands/ListSecurityGroupUsersCommand.js +16 -0
- package/dist-es/commands/ListSecurityGroupsCommand.js +16 -0
- package/dist-es/commands/ListUsersCommand.js +16 -0
- package/dist-es/commands/RegisterOidcConfigCommand.js +16 -0
- package/dist-es/commands/RegisterOidcConfigTestCommand.js +16 -0
- package/dist-es/commands/UpdateBotCommand.js +16 -0
- package/dist-es/commands/UpdateDataRetentionCommand.js +16 -0
- package/dist-es/commands/UpdateGuestUserCommand.js +16 -0
- package/dist-es/commands/UpdateNetworkCommand.js +16 -0
- package/dist-es/commands/UpdateNetworkSettingsCommand.js +16 -0
- package/dist-es/commands/UpdateSecurityGroupCommand.js +16 -0
- package/dist-es/commands/UpdateUserCommand.js +16 -0
- package/dist-es/commands/index.js +42 -0
- package/dist-es/endpoint/EndpointParameters.js +13 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +9 -0
- package/dist-es/models/WickrServiceException.js +8 -0
- package/dist-es/models/enums.js +28 -0
- package/dist-es/models/errors.js +87 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListBlockedGuestUsersPaginator.js +4 -0
- package/dist-es/pagination/ListBotsPaginator.js +4 -0
- package/dist-es/pagination/ListDevicesForUserPaginator.js +4 -0
- package/dist-es/pagination/ListGuestUsersPaginator.js +4 -0
- package/dist-es/pagination/ListNetworksPaginator.js +4 -0
- package/dist-es/pagination/ListSecurityGroupUsersPaginator.js +4 -0
- package/dist-es/pagination/ListSecurityGroupsPaginator.js +4 -0
- package/dist-es/pagination/ListUsersPaginator.js +4 -0
- package/dist-es/pagination/index.js +9 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +50 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +1491 -0
- package/dist-types/Wickr.d.ts +305 -0
- package/dist-types/WickrClient.d.ts +229 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/BatchCreateUserCommand.d.ts +251 -0
- package/dist-types/commands/BatchDeleteUserCommand.d.ts +171 -0
- package/dist-types/commands/BatchLookupUserUnameCommand.d.ts +175 -0
- package/dist-types/commands/BatchReinviteUserCommand.d.ts +191 -0
- package/dist-types/commands/BatchResetDevicesForUserCommand.d.ts +190 -0
- package/dist-types/commands/BatchToggleUserSuspendStatusCommand.d.ts +174 -0
- package/dist-types/commands/CreateBotCommand.d.ts +161 -0
- package/dist-types/commands/CreateDataRetentionBotChallengeCommand.d.ts +110 -0
- package/dist-types/commands/CreateDataRetentionBotCommand.d.ts +123 -0
- package/dist-types/commands/CreateNetworkCommand.d.ts +150 -0
- package/dist-types/commands/CreateSecurityGroupCommand.d.ts +241 -0
- package/dist-types/commands/DeleteBotCommand.d.ts +126 -0
- package/dist-types/commands/DeleteDataRetentionBotCommand.d.ts +110 -0
- package/dist-types/commands/DeleteNetworkCommand.d.ts +124 -0
- package/dist-types/commands/DeleteSecurityGroupCommand.d.ts +130 -0
- package/dist-types/commands/GetBotCommand.d.ts +144 -0
- package/dist-types/commands/GetBotsCountCommand.d.ts +131 -0
- package/dist-types/commands/GetDataRetentionBotCommand.d.ts +140 -0
- package/dist-types/commands/GetGuestUserHistoryCountCommand.d.ts +155 -0
- package/dist-types/commands/GetNetworkCommand.d.ts +137 -0
- package/dist-types/commands/GetNetworkSettingsCommand.d.ts +166 -0
- package/dist-types/commands/GetOidcInfoCommand.d.ts +169 -0
- package/dist-types/commands/GetSecurityGroupCommand.d.ts +211 -0
- package/dist-types/commands/GetUserCommand.d.ts +194 -0
- package/dist-types/commands/GetUsersCountCommand.d.ts +137 -0
- package/dist-types/commands/ListBlockedGuestUsersCommand.d.ts +185 -0
- package/dist-types/commands/ListBotsCommand.d.ts +192 -0
- package/dist-types/commands/ListDevicesForUserCommand.d.ts +197 -0
- package/dist-types/commands/ListGuestUsersCommand.d.ts +192 -0
- package/dist-types/commands/ListNetworksCommand.d.ts +167 -0
- package/dist-types/commands/ListSecurityGroupUsersCommand.d.ts +156 -0
- package/dist-types/commands/ListSecurityGroupsCommand.d.ts +246 -0
- package/dist-types/commands/ListUsersCommand.d.ts +221 -0
- package/dist-types/commands/RegisterOidcConfigCommand.d.ts +174 -0
- package/dist-types/commands/RegisterOidcConfigTestCommand.d.ts +168 -0
- package/dist-types/commands/UpdateBotCommand.d.ts +133 -0
- package/dist-types/commands/UpdateDataRetentionCommand.d.ts +144 -0
- package/dist-types/commands/UpdateGuestUserCommand.d.ts +146 -0
- package/dist-types/commands/UpdateNetworkCommand.d.ts +142 -0
- package/dist-types/commands/UpdateNetworkSettingsCommand.d.ts +234 -0
- package/dist-types/commands/UpdateSecurityGroupCommand.d.ts +282 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +229 -0
- package/dist-types/commands/index.d.ts +42 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +17 -0
- package/dist-types/models/WickrServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +58 -0
- package/dist-types/models/errors.d.ts +92 -0
- package/dist-types/models/models_0.d.ts +2975 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListBlockedGuestUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBotsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDevicesForUserPaginator.d.ts +7 -0
- package/dist-types/pagination/ListGuestUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNetworksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSecurityGroupUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSecurityGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +27 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +164 -0
- package/dist-types/ts3.4/Wickr.d.ts +720 -0
- package/dist-types/ts3.4/WickrClient.d.ts +371 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchCreateUserCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchDeleteUserCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchLookupUserUnameCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchReinviteUserCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchResetDevicesForUserCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchToggleUserSuspendStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateBotCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateDataRetentionBotChallengeCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateDataRetentionBotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateNetworkCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateSecurityGroupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteBotCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteDataRetentionBotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteNetworkCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteSecurityGroupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetBotCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetBotsCountCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetDataRetentionBotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetGuestUserHistoryCountCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetNetworkCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetNetworkSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetOidcInfoCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetSecurityGroupCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +43 -0
- package/dist-types/ts3.4/commands/GetUsersCountCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListBlockedGuestUsersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListDevicesForUserCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListGuestUsersCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListNetworksCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListSecurityGroupUsersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListSecurityGroupsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/RegisterOidcConfigCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RegisterOidcConfigTestCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateBotCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateDataRetentionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateGuestUserCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateNetworkCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateNetworkSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateSecurityGroupCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +42 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +12 -0
- package/dist-types/ts3.4/models/WickrServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +31 -0
- package/dist-types/ts3.4/models/errors.d.ts +43 -0
- package/dist-types/ts3.4/models/models_0.d.ts +714 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListBlockedGuestUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBotsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDevicesForUserPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListGuestUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListNetworksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSecurityGroupUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSecurityGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +168 -0
- package/package.json +100 -0
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListSecurityGroupsRequest, ListSecurityGroupsResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListSecurityGroupsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListSecurityGroupsCommandInput extends ListSecurityGroupsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListSecurityGroupsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListSecurityGroupsCommandOutput extends ListSecurityGroupsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListSecurityGroupsCommand_base: {
|
|
25
|
+
new (input: ListSecurityGroupsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecurityGroupsCommandInput, ListSecurityGroupsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListSecurityGroupsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSecurityGroupsCommandInput, ListSecurityGroupsCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, ListSecurityGroupsCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, ListSecurityGroupsCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // ListSecurityGroupsRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* maxResults: Number("int"),
|
|
43
|
+
* sortFields: "STRING_VALUE",
|
|
44
|
+
* sortDirection: "ASC" || "DESC",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListSecurityGroupsCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListSecurityGroupsResponse
|
|
49
|
+
* // securityGroups: [ // SecurityGroupList
|
|
50
|
+
* // { // SecurityGroup
|
|
51
|
+
* // activeMembers: Number("int"), // required
|
|
52
|
+
* // botMembers: Number("int"), // required
|
|
53
|
+
* // activeDirectoryGuid: "STRING_VALUE",
|
|
54
|
+
* // id: "STRING_VALUE", // required
|
|
55
|
+
* // isDefault: true || false, // required
|
|
56
|
+
* // name: "STRING_VALUE", // required
|
|
57
|
+
* // modified: Number("int"), // required
|
|
58
|
+
* // securityGroupSettings: { // SecurityGroupSettings
|
|
59
|
+
* // alwaysReauthenticate: true || false,
|
|
60
|
+
* // atakPackageValues: [ // SecurityGroupStringList
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // calling: { // CallingSettings
|
|
64
|
+
* // canStart11Call: true || false,
|
|
65
|
+
* // canVideoCall: true || false,
|
|
66
|
+
* // forceTcpCall: true || false,
|
|
67
|
+
* // },
|
|
68
|
+
* // checkForUpdates: true || false,
|
|
69
|
+
* // enableAtak: true || false,
|
|
70
|
+
* // enableCrashReports: true || false,
|
|
71
|
+
* // enableFileDownload: true || false,
|
|
72
|
+
* // enableGuestFederation: true || false,
|
|
73
|
+
* // enableNotificationPreview: true || false,
|
|
74
|
+
* // enableOpenAccessOption: true || false,
|
|
75
|
+
* // enableRestrictedGlobalFederation: true || false,
|
|
76
|
+
* // filesEnabled: true || false,
|
|
77
|
+
* // forceDeviceLockout: Number("int"),
|
|
78
|
+
* // forceOpenAccess: true || false,
|
|
79
|
+
* // forceReadReceipts: true || false,
|
|
80
|
+
* // globalFederation: true || false,
|
|
81
|
+
* // isAtoEnabled: true || false,
|
|
82
|
+
* // isLinkPreviewEnabled: true || false,
|
|
83
|
+
* // locationAllowMaps: true || false,
|
|
84
|
+
* // locationEnabled: true || false,
|
|
85
|
+
* // maxAutoDownloadSize: Number("long"),
|
|
86
|
+
* // maxBor: Number("int"),
|
|
87
|
+
* // maxTtl: Number("long"),
|
|
88
|
+
* // messageForwardingEnabled: true || false,
|
|
89
|
+
* // passwordRequirements: { // PasswordRequirements
|
|
90
|
+
* // lowercase: Number("int"),
|
|
91
|
+
* // minLength: Number("int"),
|
|
92
|
+
* // numbers: Number("int"),
|
|
93
|
+
* // symbols: Number("int"),
|
|
94
|
+
* // uppercase: Number("int"),
|
|
95
|
+
* // },
|
|
96
|
+
* // presenceEnabled: true || false,
|
|
97
|
+
* // quickResponses: [
|
|
98
|
+
* // "STRING_VALUE",
|
|
99
|
+
* // ],
|
|
100
|
+
* // showMasterRecoveryKey: true || false,
|
|
101
|
+
* // shredder: { // ShredderSettings
|
|
102
|
+
* // canProcessManually: true || false,
|
|
103
|
+
* // intensity: Number("int"),
|
|
104
|
+
* // },
|
|
105
|
+
* // ssoMaxIdleMinutes: Number("int"),
|
|
106
|
+
* // federationMode: Number("int"),
|
|
107
|
+
* // lockoutThreshold: Number("int"),
|
|
108
|
+
* // permittedNetworks: [ // PermittedNetworksList
|
|
109
|
+
* // "STRING_VALUE",
|
|
110
|
+
* // ],
|
|
111
|
+
* // permittedWickrAwsNetworks: [ // WickrAwsNetworksList
|
|
112
|
+
* // { // WickrAwsNetworks
|
|
113
|
+
* // region: "STRING_VALUE", // required
|
|
114
|
+
* // networkId: "STRING_VALUE", // required
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // permittedWickrEnterpriseNetworks: [ // PermittedWickrEnterpriseNetworksList
|
|
118
|
+
* // { // PermittedWickrEnterpriseNetwork
|
|
119
|
+
* // domain: "STRING_VALUE", // required
|
|
120
|
+
* // networkId: "STRING_VALUE", // required
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // ],
|
|
126
|
+
* // nextToken: "STRING_VALUE",
|
|
127
|
+
* // };
|
|
128
|
+
*
|
|
129
|
+
* ```
|
|
130
|
+
*
|
|
131
|
+
* @param ListSecurityGroupsCommandInput - {@link ListSecurityGroupsCommandInput}
|
|
132
|
+
* @returns {@link ListSecurityGroupsCommandOutput}
|
|
133
|
+
* @see {@link ListSecurityGroupsCommandInput} for command's `input` shape.
|
|
134
|
+
* @see {@link ListSecurityGroupsCommandOutput} for command's `response` shape.
|
|
135
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link BadRequestError} (client fault)
|
|
138
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
141
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link InternalServerError} (server fault)
|
|
144
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link RateLimitError} (client fault)
|
|
147
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
150
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
153
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link ValidationError} (client fault)
|
|
156
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
157
|
+
*
|
|
158
|
+
* @throws {@link WickrServiceException}
|
|
159
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
160
|
+
*
|
|
161
|
+
*
|
|
162
|
+
* @example List security groups with pagination
|
|
163
|
+
* ```javascript
|
|
164
|
+
* //
|
|
165
|
+
* const input = {
|
|
166
|
+
* maxResults: 10,
|
|
167
|
+
* networkId: "12345678",
|
|
168
|
+
* sortDirection: "ASC",
|
|
169
|
+
* sortFields: "name"
|
|
170
|
+
* };
|
|
171
|
+
* const command = new ListSecurityGroupsCommand(input);
|
|
172
|
+
* const response = await client.send(command);
|
|
173
|
+
* /* response is
|
|
174
|
+
* {
|
|
175
|
+
* nextToken: "eyJvZmZzZXQiOjEwfQ==",
|
|
176
|
+
* securityGroups: [
|
|
177
|
+
* {
|
|
178
|
+
* activeMembers: 25,
|
|
179
|
+
* botMembers: 0,
|
|
180
|
+
* id: "abc12345",
|
|
181
|
+
* isDefault: true,
|
|
182
|
+
* modified: 1638360000,
|
|
183
|
+
* name: "default",
|
|
184
|
+
* securityGroupSettings: {
|
|
185
|
+
* lockoutThreshold: 10
|
|
186
|
+
* }
|
|
187
|
+
* },
|
|
188
|
+
* {
|
|
189
|
+
* activeMembers: 10,
|
|
190
|
+
* botMembers: 2,
|
|
191
|
+
* id: "def67890",
|
|
192
|
+
* isDefault: false,
|
|
193
|
+
* modified: 1638360000,
|
|
194
|
+
* name: "engineering",
|
|
195
|
+
* securityGroupSettings: {
|
|
196
|
+
* lockoutThreshold: 15
|
|
197
|
+
* }
|
|
198
|
+
* }
|
|
199
|
+
* ]
|
|
200
|
+
* }
|
|
201
|
+
* *\/
|
|
202
|
+
* ```
|
|
203
|
+
*
|
|
204
|
+
* @example List security groups - first page
|
|
205
|
+
* ```javascript
|
|
206
|
+
* //
|
|
207
|
+
* const input = {
|
|
208
|
+
* maxResults: 10,
|
|
209
|
+
* networkId: "12345678"
|
|
210
|
+
* };
|
|
211
|
+
* const command = new ListSecurityGroupsCommand(input);
|
|
212
|
+
* const response = await client.send(command);
|
|
213
|
+
* /* response is
|
|
214
|
+
* {
|
|
215
|
+
* securityGroups: [
|
|
216
|
+
* {
|
|
217
|
+
* activeMembers: 25,
|
|
218
|
+
* botMembers: 0,
|
|
219
|
+
* id: "abc12345",
|
|
220
|
+
* isDefault: true,
|
|
221
|
+
* modified: 1638360000,
|
|
222
|
+
* name: "default",
|
|
223
|
+
* securityGroupSettings: {
|
|
224
|
+
* lockoutThreshold: 10
|
|
225
|
+
* }
|
|
226
|
+
* }
|
|
227
|
+
* ]
|
|
228
|
+
* }
|
|
229
|
+
* *\/
|
|
230
|
+
* ```
|
|
231
|
+
*
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
export declare class ListSecurityGroupsCommand extends ListSecurityGroupsCommand_base {
|
|
235
|
+
/** @internal type navigation helper, not in runtime. */
|
|
236
|
+
protected static __types: {
|
|
237
|
+
api: {
|
|
238
|
+
input: ListSecurityGroupsRequest;
|
|
239
|
+
output: ListSecurityGroupsResponse;
|
|
240
|
+
};
|
|
241
|
+
sdk: {
|
|
242
|
+
input: ListSecurityGroupsCommandInput;
|
|
243
|
+
output: ListSecurityGroupsCommandOutput;
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
}
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListUsersRequest, ListUsersResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListUsersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListUsersCommandInput extends ListUsersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListUsersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListUsersCommand_base: {
|
|
25
|
+
new (input: ListUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListUsersCommandInput, ListUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListUsersCommandInput): import("@smithy/smithy-client").CommandImpl<ListUsersCommandInput, ListUsersCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, ListUsersCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, ListUsersCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // ListUsersRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* maxResults: Number("int"),
|
|
43
|
+
* sortFields: "STRING_VALUE",
|
|
44
|
+
* sortDirection: "ASC" || "DESC",
|
|
45
|
+
* firstName: "STRING_VALUE",
|
|
46
|
+
* lastName: "STRING_VALUE",
|
|
47
|
+
* username: "STRING_VALUE",
|
|
48
|
+
* status: 1 || 2,
|
|
49
|
+
* groupId: "STRING_VALUE",
|
|
50
|
+
* };
|
|
51
|
+
* const command = new ListUsersCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // ListUsersResponse
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // users: [ // Users
|
|
56
|
+
* // { // User
|
|
57
|
+
* // userId: "STRING_VALUE",
|
|
58
|
+
* // firstName: "STRING_VALUE",
|
|
59
|
+
* // lastName: "STRING_VALUE",
|
|
60
|
+
* // username: "STRING_VALUE",
|
|
61
|
+
* // securityGroups: [ // SecurityGroupIdList
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // isAdmin: true || false,
|
|
65
|
+
* // suspended: true || false,
|
|
66
|
+
* // status: Number("int"),
|
|
67
|
+
* // otpEnabled: true || false,
|
|
68
|
+
* // scimId: "STRING_VALUE",
|
|
69
|
+
* // type: "STRING_VALUE",
|
|
70
|
+
* // cell: "STRING_VALUE",
|
|
71
|
+
* // countryCode: "STRING_VALUE",
|
|
72
|
+
* // challengeFailures: Number("int"),
|
|
73
|
+
* // isInviteExpired: true || false,
|
|
74
|
+
* // isUser: true || false,
|
|
75
|
+
* // inviteCode: "STRING_VALUE",
|
|
76
|
+
* // codeValidation: true || false,
|
|
77
|
+
* // uname: "STRING_VALUE",
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // };
|
|
81
|
+
*
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @param ListUsersCommandInput - {@link ListUsersCommandInput}
|
|
85
|
+
* @returns {@link ListUsersCommandOutput}
|
|
86
|
+
* @see {@link ListUsersCommandInput} for command's `input` shape.
|
|
87
|
+
* @see {@link ListUsersCommandOutput} for command's `response` shape.
|
|
88
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link BadRequestError} (client fault)
|
|
91
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
94
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InternalServerError} (server fault)
|
|
97
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link RateLimitError} (client fault)
|
|
100
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
103
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
106
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ValidationError} (client fault)
|
|
109
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link WickrServiceException}
|
|
112
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
113
|
+
*
|
|
114
|
+
*
|
|
115
|
+
* @example Get paginated list of users
|
|
116
|
+
* ```javascript
|
|
117
|
+
* //
|
|
118
|
+
* const input = {
|
|
119
|
+
* maxResults: 20,
|
|
120
|
+
* networkId: "12345678",
|
|
121
|
+
* sortDirection: "ASC",
|
|
122
|
+
* sortFields: "username"
|
|
123
|
+
* };
|
|
124
|
+
* const command = new ListUsersCommand(input);
|
|
125
|
+
* const response = await client.send(command);
|
|
126
|
+
* /* response is
|
|
127
|
+
* {
|
|
128
|
+
* nextToken: "v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8",
|
|
129
|
+
* users: [
|
|
130
|
+
* {
|
|
131
|
+
* firstName: "Alice",
|
|
132
|
+
* isAdmin: false,
|
|
133
|
+
* lastName: "Anderson",
|
|
134
|
+
* status: 2,
|
|
135
|
+
* suspended: false,
|
|
136
|
+
* type: "user",
|
|
137
|
+
* username: "alice.anderson@example.com"
|
|
138
|
+
* },
|
|
139
|
+
* {
|
|
140
|
+
* firstName: "Bob",
|
|
141
|
+
* isAdmin: false,
|
|
142
|
+
* lastName: "Brown",
|
|
143
|
+
* status: 2,
|
|
144
|
+
* suspended: false,
|
|
145
|
+
* type: "user",
|
|
146
|
+
* username: "bob.brown@example.com"
|
|
147
|
+
* },
|
|
148
|
+
* {
|
|
149
|
+
* firstName: "Charlie",
|
|
150
|
+
* isAdmin: true,
|
|
151
|
+
* lastName: "Chen",
|
|
152
|
+
* status: 2,
|
|
153
|
+
* suspended: false,
|
|
154
|
+
* type: "user",
|
|
155
|
+
* username: "charlie.chen@example.com"
|
|
156
|
+
* }
|
|
157
|
+
* ]
|
|
158
|
+
* }
|
|
159
|
+
* *\/
|
|
160
|
+
* ```
|
|
161
|
+
*
|
|
162
|
+
* @example Filter by status and group
|
|
163
|
+
* ```javascript
|
|
164
|
+
* //
|
|
165
|
+
* const input = {
|
|
166
|
+
* groupId: "BCTY8Qhe",
|
|
167
|
+
* maxResults: 10,
|
|
168
|
+
* networkId: "12345678",
|
|
169
|
+
* status: 1
|
|
170
|
+
* };
|
|
171
|
+
* const command = new ListUsersCommand(input);
|
|
172
|
+
* const response = await client.send(command);
|
|
173
|
+
* /* response is
|
|
174
|
+
* {
|
|
175
|
+
* users: [
|
|
176
|
+
* {
|
|
177
|
+
* firstName: "David",
|
|
178
|
+
* inviteCode: "INVITE789",
|
|
179
|
+
* isAdmin: false,
|
|
180
|
+
* isInviteExpired: false,
|
|
181
|
+
* lastName: "Davis",
|
|
182
|
+
* status: 1,
|
|
183
|
+
* suspended: false,
|
|
184
|
+
* type: "user",
|
|
185
|
+
* username: "david.davis@example.com"
|
|
186
|
+
* }
|
|
187
|
+
* ]
|
|
188
|
+
* }
|
|
189
|
+
* *\/
|
|
190
|
+
* ```
|
|
191
|
+
*
|
|
192
|
+
* @example Empty user list for network with no users
|
|
193
|
+
* ```javascript
|
|
194
|
+
* //
|
|
195
|
+
* const input = {
|
|
196
|
+
* networkId: "12345678"
|
|
197
|
+
* };
|
|
198
|
+
* const command = new ListUsersCommand(input);
|
|
199
|
+
* const response = await client.send(command);
|
|
200
|
+
* /* response is
|
|
201
|
+
* {
|
|
202
|
+
* users: []
|
|
203
|
+
* }
|
|
204
|
+
* *\/
|
|
205
|
+
* ```
|
|
206
|
+
*
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
export declare class ListUsersCommand extends ListUsersCommand_base {
|
|
210
|
+
/** @internal type navigation helper, not in runtime. */
|
|
211
|
+
protected static __types: {
|
|
212
|
+
api: {
|
|
213
|
+
input: ListUsersRequest;
|
|
214
|
+
output: ListUsersResponse;
|
|
215
|
+
};
|
|
216
|
+
sdk: {
|
|
217
|
+
input: ListUsersCommandInput;
|
|
218
|
+
output: ListUsersCommandOutput;
|
|
219
|
+
};
|
|
220
|
+
};
|
|
221
|
+
}
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { RegisterOidcConfigRequest, RegisterOidcConfigResponse } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WickrClientResolvedConfig } from "../WickrClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link RegisterOidcConfigCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RegisterOidcConfigCommandInput extends RegisterOidcConfigRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RegisterOidcConfigCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RegisterOidcConfigCommandOutput extends RegisterOidcConfigResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RegisterOidcConfigCommand_base: {
|
|
25
|
+
new (input: RegisterOidcConfigCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterOidcConfigCommandInput, RegisterOidcConfigCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: RegisterOidcConfigCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterOidcConfigCommandInput, RegisterOidcConfigCommandOutput, WickrClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WickrClient, RegisterOidcConfigCommand } from "@aws-sdk/client-wickr"; // ES Modules import
|
|
35
|
+
* // const { WickrClient, RegisterOidcConfigCommand } = require("@aws-sdk/client-wickr"); // CommonJS import
|
|
36
|
+
* // import type { WickrClientConfig } from "@aws-sdk/client-wickr";
|
|
37
|
+
* const config = {}; // type is WickrClientConfig
|
|
38
|
+
* const client = new WickrClient(config);
|
|
39
|
+
* const input = { // RegisterOidcConfigRequest
|
|
40
|
+
* networkId: "STRING_VALUE", // required
|
|
41
|
+
* companyId: "STRING_VALUE", // required
|
|
42
|
+
* customUsername: "STRING_VALUE",
|
|
43
|
+
* extraAuthParams: "STRING_VALUE",
|
|
44
|
+
* issuer: "STRING_VALUE", // required
|
|
45
|
+
* scopes: "STRING_VALUE", // required
|
|
46
|
+
* secret: "STRING_VALUE",
|
|
47
|
+
* ssoTokenBufferMinutes: Number("int"),
|
|
48
|
+
* userId: "STRING_VALUE",
|
|
49
|
+
* };
|
|
50
|
+
* const command = new RegisterOidcConfigCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // RegisterOidcConfigResponse
|
|
53
|
+
* // applicationName: "STRING_VALUE",
|
|
54
|
+
* // clientId: "STRING_VALUE",
|
|
55
|
+
* // companyId: "STRING_VALUE", // required
|
|
56
|
+
* // scopes: "STRING_VALUE", // required
|
|
57
|
+
* // issuer: "STRING_VALUE", // required
|
|
58
|
+
* // clientSecret: "STRING_VALUE",
|
|
59
|
+
* // secret: "STRING_VALUE",
|
|
60
|
+
* // redirectUrl: "STRING_VALUE",
|
|
61
|
+
* // userId: "STRING_VALUE",
|
|
62
|
+
* // customUsername: "STRING_VALUE",
|
|
63
|
+
* // caCertificate: "STRING_VALUE",
|
|
64
|
+
* // applicationId: Number("int"),
|
|
65
|
+
* // ssoTokenBufferMinutes: Number("int"),
|
|
66
|
+
* // extraAuthParams: "STRING_VALUE",
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param RegisterOidcConfigCommandInput - {@link RegisterOidcConfigCommandInput}
|
|
72
|
+
* @returns {@link RegisterOidcConfigCommandOutput}
|
|
73
|
+
* @see {@link RegisterOidcConfigCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link RegisterOidcConfigCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link WickrClientResolvedConfig | config} for WickrClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link BadRequestError} (client fault)
|
|
78
|
+
* <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
81
|
+
* <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerError} (server fault)
|
|
84
|
+
* <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link RateLimitError} (client fault)
|
|
87
|
+
* <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ResourceNotFoundError} (client fault)
|
|
90
|
+
* <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
93
|
+
* <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ValidationError} (client fault)
|
|
96
|
+
* <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link WickrServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from Wickr service.</p>
|
|
100
|
+
*
|
|
101
|
+
*
|
|
102
|
+
* @example Save OIDC config successfully
|
|
103
|
+
* ```javascript
|
|
104
|
+
* //
|
|
105
|
+
* const input = {
|
|
106
|
+
* companyId: "us-east-1-company123",
|
|
107
|
+
* issuer: "https://login.example.com",
|
|
108
|
+
* networkId: "12345678",
|
|
109
|
+
* scopes: "openid profile email",
|
|
110
|
+
* ssoTokenBufferMinutes: 5,
|
|
111
|
+
* userId: "email"
|
|
112
|
+
* };
|
|
113
|
+
* const command = new RegisterOidcConfigCommand(input);
|
|
114
|
+
* const response = await client.send(command);
|
|
115
|
+
* /* response is
|
|
116
|
+
* {
|
|
117
|
+
* clientId: "client123",
|
|
118
|
+
* companyId: "us-east-1-company123",
|
|
119
|
+
* issuer: "https://login.example.com",
|
|
120
|
+
* redirectUrl: "https://app.wickr.com/callback",
|
|
121
|
+
* scopes: "openid profile email",
|
|
122
|
+
* ssoTokenBufferMinutes: 5,
|
|
123
|
+
* userId: "email"
|
|
124
|
+
* }
|
|
125
|
+
* *\/
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @example Save OIDC config - missing company ID
|
|
129
|
+
* ```javascript
|
|
130
|
+
* //
|
|
131
|
+
* const input = {
|
|
132
|
+
* companyId: "",
|
|
133
|
+
* issuer: "https://login.example.com",
|
|
134
|
+
* networkId: "12345678",
|
|
135
|
+
* scopes: "openid profile email"
|
|
136
|
+
* };
|
|
137
|
+
* const command = new RegisterOidcConfigCommand(input);
|
|
138
|
+
* const response = await client.send(command);
|
|
139
|
+
* /* response is
|
|
140
|
+
* { /* metadata only *\/ }
|
|
141
|
+
* *\/
|
|
142
|
+
* ```
|
|
143
|
+
*
|
|
144
|
+
* @example Save OIDC config - invalid company ID prefix
|
|
145
|
+
* ```javascript
|
|
146
|
+
* //
|
|
147
|
+
* const input = {
|
|
148
|
+
* companyId: "invalid-company123",
|
|
149
|
+
* issuer: "https://login.example.com",
|
|
150
|
+
* networkId: "12345678",
|
|
151
|
+
* scopes: "openid profile email"
|
|
152
|
+
* };
|
|
153
|
+
* const command = new RegisterOidcConfigCommand(input);
|
|
154
|
+
* const response = await client.send(command);
|
|
155
|
+
* /* response is
|
|
156
|
+
* { /* metadata only *\/ }
|
|
157
|
+
* *\/
|
|
158
|
+
* ```
|
|
159
|
+
*
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
export declare class RegisterOidcConfigCommand extends RegisterOidcConfigCommand_base {
|
|
163
|
+
/** @internal type navigation helper, not in runtime. */
|
|
164
|
+
protected static __types: {
|
|
165
|
+
api: {
|
|
166
|
+
input: RegisterOidcConfigRequest;
|
|
167
|
+
output: RegisterOidcConfigResponse;
|
|
168
|
+
};
|
|
169
|
+
sdk: {
|
|
170
|
+
input: RegisterOidcConfigCommandInput;
|
|
171
|
+
output: RegisterOidcConfigCommandOutput;
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
}
|