oci-identity 2.4.0 → 2.6.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.txt +6 -0
- package/lib/client.d.ts +583 -120
- package/lib/client.js +910 -240
- package/lib/client.js.map +1 -1
- package/lib/request/activate-mfa-totp-device-request.d.ts +1 -1
- package/lib/request/add-user-to-group-request.d.ts +1 -1
- package/lib/request/assemble-effective-tag-set-request.d.ts +1 -1
- package/lib/request/bulk-delete-resources-request.d.ts +1 -1
- package/lib/request/bulk-delete-tags-request.d.ts +1 -1
- package/lib/request/bulk-edit-tags-request.d.ts +1 -1
- package/lib/request/bulk-move-resources-request.d.ts +1 -1
- package/lib/request/cascade-delete-tag-namespace-request.d.ts +1 -1
- package/lib/request/change-tag-namespace-compartment-request.d.ts +1 -1
- package/lib/request/create-auth-token-request.d.ts +1 -1
- package/lib/request/create-compartment-request.d.ts +1 -1
- package/lib/request/create-customer-secret-key-request.d.ts +1 -1
- package/lib/request/create-dynamic-group-request.d.ts +1 -1
- package/lib/request/create-group-request.d.ts +1 -1
- package/lib/request/create-identity-provider-request.d.ts +1 -1
- package/lib/request/create-idp-group-mapping-request.d.ts +1 -1
- package/lib/request/create-mfa-totp-device-request.d.ts +1 -1
- package/lib/request/create-network-source-request.d.ts +1 -1
- package/lib/request/create-oauth-client-credential-request.d.ts +1 -1
- package/lib/request/create-or-reset-uipassword-request.d.ts +1 -1
- package/lib/request/create-policy-request.d.ts +1 -1
- package/lib/request/create-region-subscription-request.d.ts +1 -1
- package/lib/request/create-smtp-credential-request.d.ts +1 -1
- package/lib/request/create-swift-password-request.d.ts +1 -1
- package/lib/request/create-tag-default-request.d.ts +1 -1
- package/lib/request/create-tag-namespace-request.d.ts +1 -1
- package/lib/request/create-tag-request.d.ts +1 -1
- package/lib/request/create-user-request.d.ts +1 -1
- package/lib/request/delete-api-key-request.d.ts +1 -1
- package/lib/request/delete-auth-token-request.d.ts +1 -1
- package/lib/request/delete-compartment-request.d.ts +1 -1
- package/lib/request/delete-customer-secret-key-request.d.ts +1 -1
- package/lib/request/delete-dynamic-group-request.d.ts +1 -1
- package/lib/request/delete-group-request.d.ts +1 -1
- package/lib/request/delete-identity-provider-request.d.ts +1 -1
- package/lib/request/delete-idp-group-mapping-request.d.ts +1 -1
- package/lib/request/delete-mfa-totp-device-request.d.ts +1 -1
- package/lib/request/delete-network-source-request.d.ts +1 -1
- package/lib/request/delete-oauth-client-credential-request.d.ts +1 -1
- package/lib/request/delete-policy-request.d.ts +1 -1
- package/lib/request/delete-smtp-credential-request.d.ts +1 -1
- package/lib/request/delete-swift-password-request.d.ts +1 -1
- package/lib/request/delete-tag-default-request.d.ts +1 -1
- package/lib/request/delete-tag-namespace-request.d.ts +1 -1
- package/lib/request/delete-tag-request.d.ts +1 -1
- package/lib/request/delete-user-request.d.ts +1 -1
- package/lib/request/generate-totp-seed-request.d.ts +1 -1
- package/lib/request/get-authentication-policy-request.d.ts +1 -1
- package/lib/request/get-compartment-request.d.ts +1 -1
- package/lib/request/get-dynamic-group-request.d.ts +1 -1
- package/lib/request/get-group-request.d.ts +1 -1
- package/lib/request/get-identity-provider-request.d.ts +1 -1
- package/lib/request/get-idp-group-mapping-request.d.ts +1 -1
- package/lib/request/get-mfa-totp-device-request.d.ts +1 -1
- package/lib/request/get-network-source-request.d.ts +1 -1
- package/lib/request/get-policy-request.d.ts +1 -1
- package/lib/request/get-tag-default-request.d.ts +1 -1
- package/lib/request/get-tag-namespace-request.d.ts +1 -1
- package/lib/request/get-tag-request.d.ts +1 -1
- package/lib/request/get-tagging-work-request-request.d.ts +1 -1
- package/lib/request/get-tenancy-request.d.ts +1 -1
- package/lib/request/get-user-group-membership-request.d.ts +1 -1
- package/lib/request/get-user-request.d.ts +1 -1
- package/lib/request/get-user-uipassword-information-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-api-keys-request.d.ts +1 -1
- package/lib/request/list-auth-tokens-request.d.ts +1 -1
- package/lib/request/list-availability-domains-request.d.ts +1 -1
- package/lib/request/list-bulk-action-resource-types-request.d.ts +1 -1
- package/lib/request/list-bulk-edit-tags-resource-types-request.d.ts +1 -1
- package/lib/request/list-compartments-request.d.ts +1 -1
- package/lib/request/list-cost-tracking-tags-request.d.ts +1 -1
- package/lib/request/list-customer-secret-keys-request.d.ts +1 -1
- package/lib/request/list-dynamic-groups-request.d.ts +1 -1
- package/lib/request/list-fault-domains-request.d.ts +1 -1
- package/lib/request/list-groups-request.d.ts +1 -1
- package/lib/request/list-identity-provider-groups-request.d.ts +1 -1
- package/lib/request/list-identity-providers-request.d.ts +1 -1
- package/lib/request/list-idp-group-mappings-request.d.ts +1 -1
- package/lib/request/list-mfa-totp-devices-request.d.ts +1 -1
- package/lib/request/list-network-sources-request.d.ts +1 -1
- package/lib/request/list-oauth-client-credentials-request.d.ts +1 -1
- package/lib/request/list-policies-request.d.ts +1 -1
- package/lib/request/list-region-subscriptions-request.d.ts +1 -1
- package/lib/request/list-regions-request.d.ts +1 -1
- package/lib/request/list-smtp-credentials-request.d.ts +1 -1
- package/lib/request/list-swift-passwords-request.d.ts +1 -1
- package/lib/request/list-tag-defaults-request.d.ts +1 -1
- package/lib/request/list-tag-namespaces-request.d.ts +1 -1
- package/lib/request/list-tagging-work-request-errors-request.d.ts +1 -1
- package/lib/request/list-tagging-work-request-logs-request.d.ts +1 -1
- package/lib/request/list-tagging-work-requests-request.d.ts +1 -1
- package/lib/request/list-tags-request.d.ts +1 -1
- package/lib/request/list-user-group-memberships-request.d.ts +1 -1
- package/lib/request/list-users-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/move-compartment-request.d.ts +1 -1
- package/lib/request/recover-compartment-request.d.ts +1 -1
- package/lib/request/remove-user-from-group-request.d.ts +1 -1
- package/lib/request/reset-idp-scim-client-request.d.ts +1 -1
- package/lib/request/update-auth-token-request.d.ts +1 -1
- package/lib/request/update-authentication-policy-request.d.ts +1 -1
- package/lib/request/update-compartment-request.d.ts +1 -1
- package/lib/request/update-customer-secret-key-request.d.ts +1 -1
- package/lib/request/update-dynamic-group-request.d.ts +1 -1
- package/lib/request/update-group-request.d.ts +1 -1
- package/lib/request/update-identity-provider-request.d.ts +1 -1
- package/lib/request/update-idp-group-mapping-request.d.ts +1 -1
- package/lib/request/update-network-source-request.d.ts +1 -1
- package/lib/request/update-oauth-client-credential-request.d.ts +1 -1
- package/lib/request/update-policy-request.d.ts +1 -1
- package/lib/request/update-smtp-credential-request.d.ts +1 -1
- package/lib/request/update-swift-password-request.d.ts +1 -1
- package/lib/request/update-tag-default-request.d.ts +1 -1
- package/lib/request/update-tag-namespace-request.d.ts +1 -1
- package/lib/request/update-tag-request.d.ts +1 -1
- package/lib/request/update-user-capabilities-request.d.ts +1 -1
- package/lib/request/update-user-request.d.ts +1 -1
- package/lib/request/update-user-state-request.d.ts +1 -1
- package/lib/request/upload-api-key-request.d.ts +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -17,6 +17,9 @@ import * as responses from "./response";
|
|
|
17
17
|
import { IdentityWaiter } from "./identity-waiter";
|
|
18
18
|
export declare enum IdentityApiKeys {
|
|
19
19
|
}
|
|
20
|
+
/**
|
|
21
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
22
|
+
*/
|
|
20
23
|
export declare class IdentityClient {
|
|
21
24
|
protected static serviceEndpointTemplate: string;
|
|
22
25
|
protected "_endpoint": string;
|
|
@@ -67,10 +70,11 @@ export declare class IdentityClient {
|
|
|
67
70
|
/**
|
|
68
71
|
* Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.
|
|
69
72
|
*
|
|
73
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
70
74
|
* @param ActivateMfaTotpDeviceRequest
|
|
71
75
|
* @return ActivateMfaTotpDeviceResponse
|
|
72
76
|
* @throws OciError when an error occurs
|
|
73
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
77
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ActivateMfaTotpDevice.ts.html |here} to see how to use ActivateMfaTotpDevice API.
|
|
74
78
|
*/
|
|
75
79
|
activateMfaTotpDevice(activateMfaTotpDeviceRequest: requests.ActivateMfaTotpDeviceRequest): Promise<responses.ActivateMfaTotpDeviceResponse>;
|
|
76
80
|
/**
|
|
@@ -79,10 +83,11 @@ export declare class IdentityClient {
|
|
|
79
83
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
80
84
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
81
85
|
*
|
|
86
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
82
87
|
* @param AddUserToGroupRequest
|
|
83
88
|
* @return AddUserToGroupResponse
|
|
84
89
|
* @throws OciError when an error occurs
|
|
85
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
90
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/AddUserToGroup.ts.html |here} to see how to use AddUserToGroup API.
|
|
86
91
|
*/
|
|
87
92
|
addUserToGroup(addUserToGroupRequest: requests.AddUserToGroupRequest): Promise<responses.AddUserToGroupResponse>;
|
|
88
93
|
/**
|
|
@@ -91,10 +96,11 @@ export declare class IdentityClient {
|
|
|
91
96
|
* referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults
|
|
92
97
|
* includes all tag defaults from the current compartment back to the root compartment.
|
|
93
98
|
*
|
|
99
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
94
100
|
* @param AssembleEffectiveTagSetRequest
|
|
95
101
|
* @return AssembleEffectiveTagSetResponse
|
|
96
102
|
* @throws OciError when an error occurs
|
|
97
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
103
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/AssembleEffectiveTagSet.ts.html |here} to see how to use AssembleEffectiveTagSet API.
|
|
98
104
|
*/
|
|
99
105
|
assembleEffectiveTagSet(assembleEffectiveTagSetRequest: requests.AssembleEffectiveTagSetRequest): Promise<responses.AssembleEffectiveTagSetResponse>;
|
|
100
106
|
/**
|
|
@@ -104,10 +110,11 @@ export declare class IdentityClient {
|
|
|
104
110
|
* {@link WorkRequest}. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest}
|
|
105
111
|
* API to monitor the status of the bulk action.
|
|
106
112
|
*
|
|
113
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
107
114
|
* @param BulkDeleteResourcesRequest
|
|
108
115
|
* @return BulkDeleteResourcesResponse
|
|
109
116
|
* @throws OciError when an error occurs
|
|
110
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
117
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/BulkDeleteResources.ts.html |here} to see how to use BulkDeleteResources API.
|
|
111
118
|
*/
|
|
112
119
|
bulkDeleteResources(bulkDeleteResourcesRequest: requests.BulkDeleteResourcesRequest): Promise<responses.BulkDeleteResourcesResponse>;
|
|
113
120
|
/**
|
|
@@ -133,10 +140,11 @@ export declare class IdentityClient {
|
|
|
133
140
|
In order to delete tags, you must first retire the tags. Use {@link #updateTag(UpdateTagRequest) updateTag}
|
|
134
141
|
* to retire a tag.
|
|
135
142
|
*
|
|
143
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
136
144
|
* @param BulkDeleteTagsRequest
|
|
137
145
|
* @return BulkDeleteTagsResponse
|
|
138
146
|
* @throws OciError when an error occurs
|
|
139
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
147
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/BulkDeleteTags.ts.html |here} to see how to use BulkDeleteTags API.
|
|
140
148
|
*/
|
|
141
149
|
bulkDeleteTags(bulkDeleteTagsRequest: requests.BulkDeleteTagsRequest): Promise<responses.BulkDeleteTagsResponse>;
|
|
142
150
|
/**
|
|
@@ -155,10 +163,11 @@ export declare class IdentityClient {
|
|
|
155
163
|
* For example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`,
|
|
156
164
|
* `tag set-1` and `tag set-2` cannot have any common tag definitions.
|
|
157
165
|
*
|
|
166
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
158
167
|
* @param BulkEditTagsRequest
|
|
159
168
|
* @return BulkEditTagsResponse
|
|
160
169
|
* @throws OciError when an error occurs
|
|
161
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
170
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/BulkEditTags.ts.html |here} to see how to use BulkEditTags API.
|
|
162
171
|
*/
|
|
163
172
|
bulkEditTags(bulkEditTagsRequest: requests.BulkEditTagsRequest): Promise<responses.BulkEditTagsResponse>;
|
|
164
173
|
/**
|
|
@@ -168,10 +177,11 @@ export declare class IdentityClient {
|
|
|
168
177
|
* compartments. This operation creates a {@link WorkRequest}.
|
|
169
178
|
* Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.
|
|
170
179
|
*
|
|
180
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
171
181
|
* @param BulkMoveResourcesRequest
|
|
172
182
|
* @return BulkMoveResourcesResponse
|
|
173
183
|
* @throws OciError when an error occurs
|
|
174
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
184
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/BulkMoveResources.ts.html |here} to see how to use BulkMoveResources API.
|
|
175
185
|
*/
|
|
176
186
|
bulkMoveResources(bulkMoveResourcesRequest: requests.BulkMoveResourcesRequest): Promise<responses.BulkMoveResourcesResponse>;
|
|
177
187
|
/**
|
|
@@ -195,10 +205,11 @@ export declare class IdentityClient {
|
|
|
195
205
|
To delete a tag namespace, you must first retire it. Use {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}
|
|
196
206
|
* to retire a tag namespace.
|
|
197
207
|
*
|
|
208
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
198
209
|
* @param CascadeDeleteTagNamespaceRequest
|
|
199
210
|
* @return CascadeDeleteTagNamespaceResponse
|
|
200
211
|
* @throws OciError when an error occurs
|
|
201
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
212
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CascadeDeleteTagNamespace.ts.html |here} to see how to use CascadeDeleteTagNamespace API.
|
|
202
213
|
*/
|
|
203
214
|
cascadeDeleteTagNamespace(cascadeDeleteTagNamespaceRequest: requests.CascadeDeleteTagNamespaceRequest): Promise<responses.CascadeDeleteTagNamespaceResponse>;
|
|
204
215
|
/**
|
|
@@ -209,10 +220,11 @@ export declare class IdentityClient {
|
|
|
209
220
|
* <p>
|
|
210
221
|
Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
|
|
211
222
|
*
|
|
223
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
212
224
|
* @param ChangeTagNamespaceCompartmentRequest
|
|
213
225
|
* @return ChangeTagNamespaceCompartmentResponse
|
|
214
226
|
* @throws OciError when an error occurs
|
|
215
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
227
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ChangeTagNamespaceCompartment.ts.html |here} to see how to use ChangeTagNamespaceCompartment API.
|
|
216
228
|
*/
|
|
217
229
|
changeTagNamespaceCompartment(changeTagNamespaceCompartmentRequest: requests.ChangeTagNamespaceCompartmentRequest): Promise<responses.ChangeTagNamespaceCompartmentResponse>;
|
|
218
230
|
/**
|
|
@@ -227,10 +239,11 @@ export declare class IdentityClient {
|
|
|
227
239
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
228
240
|
* tenancy can use this operation to create an auth token for any user, including themselves.
|
|
229
241
|
*
|
|
242
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
230
243
|
* @param CreateAuthTokenRequest
|
|
231
244
|
* @return CreateAuthTokenResponse
|
|
232
245
|
* @throws OciError when an error occurs
|
|
233
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
246
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateAuthToken.ts.html |here} to see how to use CreateAuthToken API.
|
|
234
247
|
*/
|
|
235
248
|
createAuthToken(createAuthTokenRequest: requests.CreateAuthTokenRequest): Promise<responses.CreateAuthTokenResponse>;
|
|
236
249
|
/**
|
|
@@ -254,10 +267,11 @@ export declare class IdentityClient {
|
|
|
254
267
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
255
268
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
256
269
|
*
|
|
270
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
257
271
|
* @param CreateCompartmentRequest
|
|
258
272
|
* @return CreateCompartmentResponse
|
|
259
273
|
* @throws OciError when an error occurs
|
|
260
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
274
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateCompartment.ts.html |here} to see how to use CreateCompartment API.
|
|
261
275
|
*/
|
|
262
276
|
createCompartment(createCompartmentRequest: requests.CreateCompartmentRequest): Promise<responses.CreateCompartmentResponse>;
|
|
263
277
|
/**
|
|
@@ -273,10 +287,11 @@ export declare class IdentityClient {
|
|
|
273
287
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
274
288
|
* tenancy can use this operation to create a secret key for any user, including themselves.
|
|
275
289
|
*
|
|
290
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
276
291
|
* @param CreateCustomerSecretKeyRequest
|
|
277
292
|
* @return CreateCustomerSecretKeyResponse
|
|
278
293
|
* @throws OciError when an error occurs
|
|
279
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
294
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateCustomerSecretKey.ts.html |here} to see how to use CreateCustomerSecretKey API.
|
|
280
295
|
*/
|
|
281
296
|
createCustomerSecretKey(createCustomerSecretKeyRequest: requests.CreateCustomerSecretKeyRequest): Promise<responses.CreateCustomerSecretKeyResponse>;
|
|
282
297
|
/**
|
|
@@ -299,10 +314,11 @@ export declare class IdentityClient {
|
|
|
299
314
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
300
315
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
301
316
|
*
|
|
317
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
302
318
|
* @param CreateDynamicGroupRequest
|
|
303
319
|
* @return CreateDynamicGroupResponse
|
|
304
320
|
* @throws OciError when an error occurs
|
|
305
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
321
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateDynamicGroup.ts.html |here} to see how to use CreateDynamicGroup API.
|
|
306
322
|
*/
|
|
307
323
|
createDynamicGroup(createDynamicGroupRequest: requests.CreateDynamicGroupRequest): Promise<responses.CreateDynamicGroupResponse>;
|
|
308
324
|
/**
|
|
@@ -328,10 +344,11 @@ export declare class IdentityClient {
|
|
|
328
344
|
* See {@link #addUserToGroup(AddUserToGroupRequest) addUserToGroup} and
|
|
329
345
|
* {@link #createPolicy(CreatePolicyRequest) createPolicy}.
|
|
330
346
|
*
|
|
347
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
331
348
|
* @param CreateGroupRequest
|
|
332
349
|
* @return CreateGroupResponse
|
|
333
350
|
* @throws OciError when an error occurs
|
|
334
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
351
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateGroup.ts.html |here} to see how to use CreateGroup API.
|
|
335
352
|
*/
|
|
336
353
|
createGroup(createGroupRequest: requests.CreateGroupRequest): Promise<responses.CreateGroupResponse>;
|
|
337
354
|
/**
|
|
@@ -354,29 +371,32 @@ export declare class IdentityClient {
|
|
|
354
371
|
* be CREATING. Before using the object, first make sure its `lifecycleState` has
|
|
355
372
|
* changed to ACTIVE.
|
|
356
373
|
*
|
|
374
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
357
375
|
* @param CreateIdentityProviderRequest
|
|
358
376
|
* @return CreateIdentityProviderResponse
|
|
359
377
|
* @throws OciError when an error occurs
|
|
360
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
378
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateIdentityProvider.ts.html |here} to see how to use CreateIdentityProvider API.
|
|
361
379
|
*/
|
|
362
380
|
createIdentityProvider(createIdentityProviderRequest: requests.CreateIdentityProviderRequest): Promise<responses.CreateIdentityProviderResponse>;
|
|
363
381
|
/**
|
|
364
382
|
* Creates a single mapping between an IdP group and an IAM Service
|
|
365
383
|
* {@link Group}.
|
|
366
384
|
*
|
|
385
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
367
386
|
* @param CreateIdpGroupMappingRequest
|
|
368
387
|
* @return CreateIdpGroupMappingResponse
|
|
369
388
|
* @throws OciError when an error occurs
|
|
370
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
389
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateIdpGroupMapping.ts.html |here} to see how to use CreateIdpGroupMapping API.
|
|
371
390
|
*/
|
|
372
391
|
createIdpGroupMapping(createIdpGroupMappingRequest: requests.CreateIdpGroupMappingRequest): Promise<responses.CreateIdpGroupMappingResponse>;
|
|
373
392
|
/**
|
|
374
393
|
* Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.
|
|
375
394
|
*
|
|
395
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
376
396
|
* @param CreateMfaTotpDeviceRequest
|
|
377
397
|
* @return CreateMfaTotpDeviceResponse
|
|
378
398
|
* @throws OciError when an error occurs
|
|
379
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
399
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateMfaTotpDevice.ts.html |here} to see how to use CreateMfaTotpDevice API.
|
|
380
400
|
*/
|
|
381
401
|
createMfaTotpDevice(createMfaTotpDeviceRequest: requests.CreateMfaTotpDeviceRequest): Promise<responses.CreateMfaTotpDeviceResponse>;
|
|
382
402
|
/**
|
|
@@ -402,19 +422,21 @@ export declare class IdentityClient {
|
|
|
402
422
|
After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed
|
|
403
423
|
* IP address specified in your network source. For more information, see [Managing Network Sources](https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).
|
|
404
424
|
*
|
|
425
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
405
426
|
* @param CreateNetworkSourceRequest
|
|
406
427
|
* @return CreateNetworkSourceResponse
|
|
407
428
|
* @throws OciError when an error occurs
|
|
408
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
429
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateNetworkSource.ts.html |here} to see how to use CreateNetworkSource API.
|
|
409
430
|
*/
|
|
410
431
|
createNetworkSource(createNetworkSourceRequest: requests.CreateNetworkSourceRequest): Promise<responses.CreateNetworkSourceResponse>;
|
|
411
432
|
/**
|
|
412
433
|
* Creates Oauth token for the user
|
|
413
434
|
*
|
|
435
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
414
436
|
* @param CreateOAuthClientCredentialRequest
|
|
415
437
|
* @return CreateOAuthClientCredentialResponse
|
|
416
438
|
* @throws OciError when an error occurs
|
|
417
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
439
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateOAuthClientCredential.ts.html |here} to see how to use CreateOAuthClientCredential API.
|
|
418
440
|
*/
|
|
419
441
|
createOAuthClientCredential(createOAuthClientCredentialRequest: requests.CreateOAuthClientCredentialRequest): Promise<responses.CreateOAuthClientCredentialResponse>;
|
|
420
442
|
/**
|
|
@@ -430,10 +452,11 @@ export declare class IdentityClient {
|
|
|
430
452
|
**Note:** The user's Console login is the unique name you specified when you created the user
|
|
431
453
|
* (see {@link #createUser(CreateUserRequest) createUser}).
|
|
432
454
|
*
|
|
455
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
433
456
|
* @param CreateOrResetUIPasswordRequest
|
|
434
457
|
* @return CreateOrResetUIPasswordResponse
|
|
435
458
|
* @throws OciError when an error occurs
|
|
436
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
459
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateOrResetUIPassword.ts.html |here} to see how to use CreateOrResetUIPassword API.
|
|
437
460
|
*/
|
|
438
461
|
createOrResetUIPassword(createOrResetUIPasswordRequest: requests.CreateOrResetUIPasswordRequest): Promise<responses.CreateOrResetUIPasswordResponse>;
|
|
439
462
|
/**
|
|
@@ -455,19 +478,21 @@ export declare class IdentityClient {
|
|
|
455
478
|
* <p>
|
|
456
479
|
New policies take effect typically within 10 seconds.
|
|
457
480
|
*
|
|
481
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
458
482
|
* @param CreatePolicyRequest
|
|
459
483
|
* @return CreatePolicyResponse
|
|
460
484
|
* @throws OciError when an error occurs
|
|
461
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
485
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreatePolicy.ts.html |here} to see how to use CreatePolicy API.
|
|
462
486
|
*/
|
|
463
487
|
createPolicy(createPolicyRequest: requests.CreatePolicyRequest): Promise<responses.CreatePolicyResponse>;
|
|
464
488
|
/**
|
|
465
489
|
* Creates a subscription to a region for a tenancy.
|
|
466
490
|
*
|
|
491
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
467
492
|
* @param CreateRegionSubscriptionRequest
|
|
468
493
|
* @return CreateRegionSubscriptionResponse
|
|
469
494
|
* @throws OciError when an error occurs
|
|
470
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
495
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateRegionSubscription.ts.html |here} to see how to use CreateRegionSubscription API.
|
|
471
496
|
*/
|
|
472
497
|
createRegionSubscription(createRegionSubscriptionRequest: requests.CreateRegionSubscriptionRequest): Promise<responses.CreateRegionSubscriptionResponse>;
|
|
473
498
|
/**
|
|
@@ -476,10 +501,11 @@ export declare class IdentityClient {
|
|
|
476
501
|
* have to be unique, and you can change it anytime with
|
|
477
502
|
* {@link #updateSmtpCredential(UpdateSmtpCredentialRequest) updateSmtpCredential}.
|
|
478
503
|
*
|
|
504
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
479
505
|
* @param CreateSmtpCredentialRequest
|
|
480
506
|
* @return CreateSmtpCredentialResponse
|
|
481
507
|
* @throws OciError when an error occurs
|
|
482
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
508
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateSmtpCredential.ts.html |here} to see how to use CreateSmtpCredential API.
|
|
483
509
|
*/
|
|
484
510
|
createSmtpCredential(createSmtpCredentialRequest: requests.CreateSmtpCredentialRequest): Promise<responses.CreateSmtpCredentialResponse>;
|
|
485
511
|
/**
|
|
@@ -496,10 +522,11 @@ export declare class IdentityClient {
|
|
|
496
522
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
497
523
|
* tenancy can use this operation to create a Swift password for any user, including themselves.
|
|
498
524
|
*
|
|
525
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
499
526
|
* @param CreateSwiftPasswordRequest
|
|
500
527
|
* @return CreateSwiftPasswordResponse
|
|
501
528
|
* @throws OciError when an error occurs
|
|
502
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
529
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateSwiftPassword.ts.html |here} to see how to use CreateSwiftPassword API.
|
|
503
530
|
*/
|
|
504
531
|
createSwiftPassword(createSwiftPasswordRequest: requests.CreateSwiftPasswordRequest): Promise<responses.CreateSwiftPasswordResponse>;
|
|
505
532
|
/**
|
|
@@ -526,10 +553,11 @@ export declare class IdentityClient {
|
|
|
526
553
|
* * If a `validator` is set, the user applying the tag to a resource must select from a list
|
|
527
554
|
* of values that you supply with {@link #enumTagDefinitionValidator(EnumTagDefinitionValidatorRequest) enumTagDefinitionValidator}.
|
|
528
555
|
*
|
|
556
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
529
557
|
* @param CreateTagRequest
|
|
530
558
|
* @return CreateTagResponse
|
|
531
559
|
* @throws OciError when an error occurs
|
|
532
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
560
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateTag.ts.html |here} to see how to use CreateTag API.
|
|
533
561
|
*/
|
|
534
562
|
createTag(createTagRequest: requests.CreateTagRequest): Promise<responses.CreateTagResponse>;
|
|
535
563
|
/**
|
|
@@ -542,10 +570,11 @@ export declare class IdentityClient {
|
|
|
542
570
|
* If the `isRequired` flag is set to \"true\", the value is set during resource creation.
|
|
543
571
|
* * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
|
|
544
572
|
*
|
|
573
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
545
574
|
* @param CreateTagDefaultRequest
|
|
546
575
|
* @return CreateTagDefaultResponse
|
|
547
576
|
* @throws OciError when an error occurs
|
|
548
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
577
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateTagDefault.ts.html |here} to see how to use CreateTagDefault API.
|
|
549
578
|
*/
|
|
550
579
|
createTagDefault(createTagDefaultRequest: requests.CreateTagDefaultRequest): Promise<responses.CreateTagDefaultResponse>;
|
|
551
580
|
/**
|
|
@@ -564,10 +593,11 @@ export declare class IdentityClient {
|
|
|
564
593
|
* It does not have to be unique, and you can change it with
|
|
565
594
|
* {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}.
|
|
566
595
|
*
|
|
596
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
567
597
|
* @param CreateTagNamespaceRequest
|
|
568
598
|
* @return CreateTagNamespaceResponse
|
|
569
599
|
* @throws OciError when an error occurs
|
|
570
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
600
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateTagNamespace.ts.html |here} to see how to use CreateTagNamespace API.
|
|
571
601
|
*/
|
|
572
602
|
createTagNamespace(createTagNamespaceRequest: requests.CreateTagNamespaceRequest): Promise<responses.CreateTagNamespaceResponse>;
|
|
573
603
|
/**
|
|
@@ -607,10 +637,11 @@ export declare class IdentityClient {
|
|
|
607
637
|
* <p>
|
|
608
638
|
**Important:** Make sure to inform the new user which compartment(s) they have access to.
|
|
609
639
|
*
|
|
640
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
610
641
|
* @param CreateUserRequest
|
|
611
642
|
* @return CreateUserResponse
|
|
612
643
|
* @throws OciError when an error occurs
|
|
613
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
644
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/CreateUser.ts.html |here} to see how to use CreateUser API.
|
|
614
645
|
*/
|
|
615
646
|
createUser(createUserRequest: requests.CreateUserRequest): Promise<responses.CreateUserResponse>;
|
|
616
647
|
/**
|
|
@@ -621,117 +652,130 @@ export declare class IdentityClient {
|
|
|
621
652
|
* To compare, administrators who have permission to the tenancy can use this operation to delete
|
|
622
653
|
* a key for any user, including themselves.
|
|
623
654
|
*
|
|
655
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
624
656
|
* @param DeleteApiKeyRequest
|
|
625
657
|
* @return DeleteApiKeyResponse
|
|
626
658
|
* @throws OciError when an error occurs
|
|
627
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
659
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteApiKey.ts.html |here} to see how to use DeleteApiKey API.
|
|
628
660
|
*/
|
|
629
661
|
deleteApiKey(deleteApiKeyRequest: requests.DeleteApiKeyRequest): Promise<responses.DeleteApiKeyResponse>;
|
|
630
662
|
/**
|
|
631
663
|
* Deletes the specified auth token for the specified user.
|
|
632
664
|
*
|
|
665
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
633
666
|
* @param DeleteAuthTokenRequest
|
|
634
667
|
* @return DeleteAuthTokenResponse
|
|
635
668
|
* @throws OciError when an error occurs
|
|
636
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
669
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteAuthToken.ts.html |here} to see how to use DeleteAuthToken API.
|
|
637
670
|
*/
|
|
638
671
|
deleteAuthToken(deleteAuthTokenRequest: requests.DeleteAuthTokenRequest): Promise<responses.DeleteAuthTokenResponse>;
|
|
639
672
|
/**
|
|
640
673
|
* Deletes the specified compartment. The compartment must be empty.
|
|
641
674
|
*
|
|
675
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
642
676
|
* @param DeleteCompartmentRequest
|
|
643
677
|
* @return DeleteCompartmentResponse
|
|
644
678
|
* @throws OciError when an error occurs
|
|
645
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
679
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteCompartment.ts.html |here} to see how to use DeleteCompartment API.
|
|
646
680
|
*/
|
|
647
681
|
deleteCompartment(deleteCompartmentRequest: requests.DeleteCompartmentRequest): Promise<responses.DeleteCompartmentResponse>;
|
|
648
682
|
/**
|
|
649
683
|
* Deletes the specified secret key for the specified user.
|
|
650
684
|
*
|
|
685
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
651
686
|
* @param DeleteCustomerSecretKeyRequest
|
|
652
687
|
* @return DeleteCustomerSecretKeyResponse
|
|
653
688
|
* @throws OciError when an error occurs
|
|
654
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
689
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteCustomerSecretKey.ts.html |here} to see how to use DeleteCustomerSecretKey API.
|
|
655
690
|
*/
|
|
656
691
|
deleteCustomerSecretKey(deleteCustomerSecretKeyRequest: requests.DeleteCustomerSecretKeyRequest): Promise<responses.DeleteCustomerSecretKeyResponse>;
|
|
657
692
|
/**
|
|
658
693
|
* Deletes the specified dynamic group.
|
|
659
694
|
*
|
|
695
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
660
696
|
* @param DeleteDynamicGroupRequest
|
|
661
697
|
* @return DeleteDynamicGroupResponse
|
|
662
698
|
* @throws OciError when an error occurs
|
|
663
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
699
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteDynamicGroup.ts.html |here} to see how to use DeleteDynamicGroup API.
|
|
664
700
|
*/
|
|
665
701
|
deleteDynamicGroup(deleteDynamicGroupRequest: requests.DeleteDynamicGroupRequest): Promise<responses.DeleteDynamicGroupResponse>;
|
|
666
702
|
/**
|
|
667
703
|
* Deletes the specified group. The group must be empty.
|
|
668
704
|
*
|
|
705
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
669
706
|
* @param DeleteGroupRequest
|
|
670
707
|
* @return DeleteGroupResponse
|
|
671
708
|
* @throws OciError when an error occurs
|
|
672
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
709
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteGroup.ts.html |here} to see how to use DeleteGroup API.
|
|
673
710
|
*/
|
|
674
711
|
deleteGroup(deleteGroupRequest: requests.DeleteGroupRequest): Promise<responses.DeleteGroupResponse>;
|
|
675
712
|
/**
|
|
676
713
|
* Deletes the specified identity provider. The identity provider must not have
|
|
677
714
|
* any group mappings (see {@link IdpGroupMapping}).
|
|
678
715
|
*
|
|
716
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
679
717
|
* @param DeleteIdentityProviderRequest
|
|
680
718
|
* @return DeleteIdentityProviderResponse
|
|
681
719
|
* @throws OciError when an error occurs
|
|
682
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
720
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteIdentityProvider.ts.html |here} to see how to use DeleteIdentityProvider API.
|
|
683
721
|
*/
|
|
684
722
|
deleteIdentityProvider(deleteIdentityProviderRequest: requests.DeleteIdentityProviderRequest): Promise<responses.DeleteIdentityProviderResponse>;
|
|
685
723
|
/**
|
|
686
724
|
* Deletes the specified group mapping.
|
|
725
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
687
726
|
* @param DeleteIdpGroupMappingRequest
|
|
688
727
|
* @return DeleteIdpGroupMappingResponse
|
|
689
728
|
* @throws OciError when an error occurs
|
|
690
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
729
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteIdpGroupMapping.ts.html |here} to see how to use DeleteIdpGroupMapping API.
|
|
691
730
|
*/
|
|
692
731
|
deleteIdpGroupMapping(deleteIdpGroupMappingRequest: requests.DeleteIdpGroupMappingRequest): Promise<responses.DeleteIdpGroupMappingResponse>;
|
|
693
732
|
/**
|
|
694
733
|
* Deletes the specified MFA TOTP device for the specified user.
|
|
695
734
|
*
|
|
735
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
696
736
|
* @param DeleteMfaTotpDeviceRequest
|
|
697
737
|
* @return DeleteMfaTotpDeviceResponse
|
|
698
738
|
* @throws OciError when an error occurs
|
|
699
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
739
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteMfaTotpDevice.ts.html |here} to see how to use DeleteMfaTotpDevice API.
|
|
700
740
|
*/
|
|
701
741
|
deleteMfaTotpDevice(deleteMfaTotpDeviceRequest: requests.DeleteMfaTotpDeviceRequest): Promise<responses.DeleteMfaTotpDeviceResponse>;
|
|
702
742
|
/**
|
|
703
743
|
* Deletes the specified network source
|
|
704
744
|
*
|
|
745
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
705
746
|
* @param DeleteNetworkSourceRequest
|
|
706
747
|
* @return DeleteNetworkSourceResponse
|
|
707
748
|
* @throws OciError when an error occurs
|
|
708
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
749
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteNetworkSource.ts.html |here} to see how to use DeleteNetworkSource API.
|
|
709
750
|
*/
|
|
710
751
|
deleteNetworkSource(deleteNetworkSourceRequest: requests.DeleteNetworkSourceRequest): Promise<responses.DeleteNetworkSourceResponse>;
|
|
711
752
|
/**
|
|
712
753
|
* Delete Oauth token for the user
|
|
713
754
|
*
|
|
755
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
714
756
|
* @param DeleteOAuthClientCredentialRequest
|
|
715
757
|
* @return DeleteOAuthClientCredentialResponse
|
|
716
758
|
* @throws OciError when an error occurs
|
|
717
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
759
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteOAuthClientCredential.ts.html |here} to see how to use DeleteOAuthClientCredential API.
|
|
718
760
|
*/
|
|
719
761
|
deleteOAuthClientCredential(deleteOAuthClientCredentialRequest: requests.DeleteOAuthClientCredentialRequest): Promise<responses.DeleteOAuthClientCredentialResponse>;
|
|
720
762
|
/**
|
|
721
763
|
* Deletes the specified policy. The deletion takes effect typically within 10 seconds.
|
|
764
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
722
765
|
* @param DeletePolicyRequest
|
|
723
766
|
* @return DeletePolicyResponse
|
|
724
767
|
* @throws OciError when an error occurs
|
|
725
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
768
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeletePolicy.ts.html |here} to see how to use DeletePolicy API.
|
|
726
769
|
*/
|
|
727
770
|
deletePolicy(deletePolicyRequest: requests.DeletePolicyRequest): Promise<responses.DeletePolicyResponse>;
|
|
728
771
|
/**
|
|
729
772
|
* Deletes the specified SMTP credential for the specified user.
|
|
730
773
|
*
|
|
774
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
731
775
|
* @param DeleteSmtpCredentialRequest
|
|
732
776
|
* @return DeleteSmtpCredentialResponse
|
|
733
777
|
* @throws OciError when an error occurs
|
|
734
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
778
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteSmtpCredential.ts.html |here} to see how to use DeleteSmtpCredential API.
|
|
735
779
|
*/
|
|
736
780
|
deleteSmtpCredential(deleteSmtpCredentialRequest: requests.DeleteSmtpCredentialRequest): Promise<responses.DeleteSmtpCredentialResponse>;
|
|
737
781
|
/**
|
|
@@ -739,10 +783,11 @@ export declare class IdentityClient {
|
|
|
739
783
|
* <p>
|
|
740
784
|
Deletes the specified Swift password for the specified user.
|
|
741
785
|
*
|
|
786
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
742
787
|
* @param DeleteSwiftPasswordRequest
|
|
743
788
|
* @return DeleteSwiftPasswordResponse
|
|
744
789
|
* @throws OciError when an error occurs
|
|
745
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
790
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteSwiftPassword.ts.html |here} to see how to use DeleteSwiftPassword API.
|
|
746
791
|
*/
|
|
747
792
|
deleteSwiftPassword(deleteSwiftPasswordRequest: requests.DeleteSwiftPasswordRequest): Promise<responses.DeleteSwiftPasswordResponse>;
|
|
748
793
|
/**
|
|
@@ -768,19 +813,21 @@ export declare class IdentityClient {
|
|
|
768
813
|
To delete a tag, you must first retire it. Use {@link #updateTag(UpdateTagRequest) updateTag}
|
|
769
814
|
* to retire a tag.
|
|
770
815
|
*
|
|
816
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
771
817
|
* @param DeleteTagRequest
|
|
772
818
|
* @return DeleteTagResponse
|
|
773
819
|
* @throws OciError when an error occurs
|
|
774
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
820
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteTag.ts.html |here} to see how to use DeleteTag API.
|
|
775
821
|
*/
|
|
776
822
|
deleteTag(deleteTagRequest: requests.DeleteTagRequest): Promise<responses.DeleteTagResponse>;
|
|
777
823
|
/**
|
|
778
824
|
* Deletes the the specified tag default.
|
|
779
825
|
*
|
|
826
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
780
827
|
* @param DeleteTagDefaultRequest
|
|
781
828
|
* @return DeleteTagDefaultResponse
|
|
782
829
|
* @throws OciError when an error occurs
|
|
783
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
830
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteTagDefault.ts.html |here} to see how to use DeleteTagDefault API.
|
|
784
831
|
*/
|
|
785
832
|
deleteTagDefault(deleteTagDefaultRequest: requests.DeleteTagDefaultRequest): Promise<responses.DeleteTagDefaultResponse>;
|
|
786
833
|
/**
|
|
@@ -792,37 +839,41 @@ export declare class IdentityClient {
|
|
|
792
839
|
* <p>
|
|
793
840
|
Use {@link #deleteTag(DeleteTagRequest) deleteTag} to delete a tag definition.
|
|
794
841
|
*
|
|
842
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
795
843
|
* @param DeleteTagNamespaceRequest
|
|
796
844
|
* @return DeleteTagNamespaceResponse
|
|
797
845
|
* @throws OciError when an error occurs
|
|
798
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
846
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteTagNamespace.ts.html |here} to see how to use DeleteTagNamespace API.
|
|
799
847
|
*/
|
|
800
848
|
deleteTagNamespace(deleteTagNamespaceRequest: requests.DeleteTagNamespaceRequest): Promise<responses.DeleteTagNamespaceResponse>;
|
|
801
849
|
/**
|
|
802
850
|
* Deletes the specified user. The user must not be in any groups.
|
|
851
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
803
852
|
* @param DeleteUserRequest
|
|
804
853
|
* @return DeleteUserResponse
|
|
805
854
|
* @throws OciError when an error occurs
|
|
806
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
855
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/DeleteUser.ts.html |here} to see how to use DeleteUser API.
|
|
807
856
|
*/
|
|
808
857
|
deleteUser(deleteUserRequest: requests.DeleteUserRequest): Promise<responses.DeleteUserResponse>;
|
|
809
858
|
/**
|
|
810
859
|
* Generate seed for the MFA TOTP device.
|
|
811
860
|
*
|
|
861
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
812
862
|
* @param GenerateTotpSeedRequest
|
|
813
863
|
* @return GenerateTotpSeedResponse
|
|
814
864
|
* @throws OciError when an error occurs
|
|
815
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
865
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GenerateTotpSeed.ts.html |here} to see how to use GenerateTotpSeed API.
|
|
816
866
|
*/
|
|
817
867
|
generateTotpSeed(generateTotpSeedRequest: requests.GenerateTotpSeedRequest): Promise<responses.GenerateTotpSeedResponse>;
|
|
818
868
|
/**
|
|
819
869
|
* Gets the authentication policy for the given tenancy. You must specify your tenant\u2019s OCID as the value for
|
|
820
870
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
821
871
|
*
|
|
872
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
822
873
|
* @param GetAuthenticationPolicyRequest
|
|
823
874
|
* @return GetAuthenticationPolicyResponse
|
|
824
875
|
* @throws OciError when an error occurs
|
|
825
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
876
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetAuthenticationPolicy.ts.html |here} to see how to use GetAuthenticationPolicy API.
|
|
826
877
|
*/
|
|
827
878
|
getAuthenticationPolicy(getAuthenticationPolicyRequest: requests.GetAuthenticationPolicyRequest): Promise<responses.GetAuthenticationPolicyResponse>;
|
|
828
879
|
/**
|
|
@@ -835,19 +886,21 @@ export declare class IdentityClient {
|
|
|
835
886
|
* call the {@link #listInstances(ListInstancesRequest) listInstances} operation in the Cloud Compute
|
|
836
887
|
* Service or the {@link #listVolumes(ListVolumesRequest) listVolumes} operation in Cloud Block Storage.
|
|
837
888
|
*
|
|
889
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
838
890
|
* @param GetCompartmentRequest
|
|
839
891
|
* @return GetCompartmentResponse
|
|
840
892
|
* @throws OciError when an error occurs
|
|
841
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
893
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetCompartment.ts.html |here} to see how to use GetCompartment API.
|
|
842
894
|
*/
|
|
843
895
|
getCompartment(getCompartmentRequest: requests.GetCompartmentRequest): Promise<responses.GetCompartmentResponse>;
|
|
844
896
|
/**
|
|
845
897
|
* Gets the specified dynamic group's information.
|
|
846
898
|
*
|
|
899
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
847
900
|
* @param GetDynamicGroupRequest
|
|
848
901
|
* @return GetDynamicGroupResponse
|
|
849
902
|
* @throws OciError when an error occurs
|
|
850
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
903
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetDynamicGroup.ts.html |here} to see how to use GetDynamicGroup API.
|
|
851
904
|
*/
|
|
852
905
|
getDynamicGroup(getDynamicGroupRequest: requests.GetDynamicGroupRequest): Promise<responses.GetDynamicGroupResponse>;
|
|
853
906
|
/**
|
|
@@ -857,132 +910,147 @@ export declare class IdentityClient {
|
|
|
857
910
|
* {@link #listUserGroupMemberships(ListUserGroupMembershipsRequest) listUserGroupMemberships} and
|
|
858
911
|
* provide the group's OCID as a query parameter in the request.
|
|
859
912
|
*
|
|
913
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
860
914
|
* @param GetGroupRequest
|
|
861
915
|
* @return GetGroupResponse
|
|
862
916
|
* @throws OciError when an error occurs
|
|
863
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
917
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetGroup.ts.html |here} to see how to use GetGroup API.
|
|
864
918
|
*/
|
|
865
919
|
getGroup(getGroupRequest: requests.GetGroupRequest): Promise<responses.GetGroupResponse>;
|
|
866
920
|
/**
|
|
867
921
|
* Gets the specified identity provider's information.
|
|
922
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
868
923
|
* @param GetIdentityProviderRequest
|
|
869
924
|
* @return GetIdentityProviderResponse
|
|
870
925
|
* @throws OciError when an error occurs
|
|
871
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
926
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetIdentityProvider.ts.html |here} to see how to use GetIdentityProvider API.
|
|
872
927
|
*/
|
|
873
928
|
getIdentityProvider(getIdentityProviderRequest: requests.GetIdentityProviderRequest): Promise<responses.GetIdentityProviderResponse>;
|
|
874
929
|
/**
|
|
875
930
|
* Gets the specified group mapping.
|
|
931
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
876
932
|
* @param GetIdpGroupMappingRequest
|
|
877
933
|
* @return GetIdpGroupMappingResponse
|
|
878
934
|
* @throws OciError when an error occurs
|
|
879
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
935
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetIdpGroupMapping.ts.html |here} to see how to use GetIdpGroupMapping API.
|
|
880
936
|
*/
|
|
881
937
|
getIdpGroupMapping(getIdpGroupMappingRequest: requests.GetIdpGroupMappingRequest): Promise<responses.GetIdpGroupMappingResponse>;
|
|
882
938
|
/**
|
|
883
939
|
* Get the specified MFA TOTP device for the specified user.
|
|
884
940
|
*
|
|
941
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
885
942
|
* @param GetMfaTotpDeviceRequest
|
|
886
943
|
* @return GetMfaTotpDeviceResponse
|
|
887
944
|
* @throws OciError when an error occurs
|
|
888
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
945
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetMfaTotpDevice.ts.html |here} to see how to use GetMfaTotpDevice API.
|
|
889
946
|
*/
|
|
890
947
|
getMfaTotpDevice(getMfaTotpDeviceRequest: requests.GetMfaTotpDeviceRequest): Promise<responses.GetMfaTotpDeviceResponse>;
|
|
891
948
|
/**
|
|
892
949
|
* Gets the specified network source's information.
|
|
893
950
|
*
|
|
951
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
894
952
|
* @param GetNetworkSourceRequest
|
|
895
953
|
* @return GetNetworkSourceResponse
|
|
896
954
|
* @throws OciError when an error occurs
|
|
897
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
955
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetNetworkSource.ts.html |here} to see how to use GetNetworkSource API.
|
|
898
956
|
*/
|
|
899
957
|
getNetworkSource(getNetworkSourceRequest: requests.GetNetworkSourceRequest): Promise<responses.GetNetworkSourceResponse>;
|
|
900
958
|
/**
|
|
901
959
|
* Gets the specified policy's information.
|
|
960
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
902
961
|
* @param GetPolicyRequest
|
|
903
962
|
* @return GetPolicyResponse
|
|
904
963
|
* @throws OciError when an error occurs
|
|
905
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
964
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetPolicy.ts.html |here} to see how to use GetPolicy API.
|
|
906
965
|
*/
|
|
907
966
|
getPolicy(getPolicyRequest: requests.GetPolicyRequest): Promise<responses.GetPolicyResponse>;
|
|
908
967
|
/**
|
|
909
968
|
* Gets the specified tag's information.
|
|
969
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
910
970
|
* @param GetTagRequest
|
|
911
971
|
* @return GetTagResponse
|
|
912
972
|
* @throws OciError when an error occurs
|
|
913
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
973
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetTag.ts.html |here} to see how to use GetTag API.
|
|
914
974
|
*/
|
|
915
975
|
getTag(getTagRequest: requests.GetTagRequest): Promise<responses.GetTagResponse>;
|
|
916
976
|
/**
|
|
917
977
|
* Retrieves the specified tag default.
|
|
918
978
|
*
|
|
979
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
919
980
|
* @param GetTagDefaultRequest
|
|
920
981
|
* @return GetTagDefaultResponse
|
|
921
982
|
* @throws OciError when an error occurs
|
|
922
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
983
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetTagDefault.ts.html |here} to see how to use GetTagDefault API.
|
|
923
984
|
*/
|
|
924
985
|
getTagDefault(getTagDefaultRequest: requests.GetTagDefaultRequest): Promise<responses.GetTagDefaultResponse>;
|
|
925
986
|
/**
|
|
926
987
|
* Gets the specified tag namespace's information.
|
|
927
988
|
*
|
|
989
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
928
990
|
* @param GetTagNamespaceRequest
|
|
929
991
|
* @return GetTagNamespaceResponse
|
|
930
992
|
* @throws OciError when an error occurs
|
|
931
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
993
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetTagNamespace.ts.html |here} to see how to use GetTagNamespace API.
|
|
932
994
|
*/
|
|
933
995
|
getTagNamespace(getTagNamespaceRequest: requests.GetTagNamespaceRequest): Promise<responses.GetTagNamespaceResponse>;
|
|
934
996
|
/**
|
|
935
997
|
* Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header
|
|
936
998
|
* for any asynchronous operation in the Identity and Access Management service.
|
|
937
999
|
*
|
|
1000
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
938
1001
|
* @param GetTaggingWorkRequestRequest
|
|
939
1002
|
* @return GetTaggingWorkRequestResponse
|
|
940
1003
|
* @throws OciError when an error occurs
|
|
941
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1004
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetTaggingWorkRequest.ts.html |here} to see how to use GetTaggingWorkRequest API.
|
|
942
1005
|
*/
|
|
943
1006
|
getTaggingWorkRequest(getTaggingWorkRequestRequest: requests.GetTaggingWorkRequestRequest): Promise<responses.GetTaggingWorkRequestResponse>;
|
|
944
1007
|
/**
|
|
945
1008
|
* Get the specified tenancy's information.
|
|
1009
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
946
1010
|
* @param GetTenancyRequest
|
|
947
1011
|
* @return GetTenancyResponse
|
|
948
1012
|
* @throws OciError when an error occurs
|
|
949
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1013
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetTenancy.ts.html |here} to see how to use GetTenancy API.
|
|
950
1014
|
*/
|
|
951
1015
|
getTenancy(getTenancyRequest: requests.GetTenancyRequest): Promise<responses.GetTenancyResponse>;
|
|
952
1016
|
/**
|
|
953
1017
|
* Gets the specified user's information.
|
|
1018
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
954
1019
|
* @param GetUserRequest
|
|
955
1020
|
* @return GetUserResponse
|
|
956
1021
|
* @throws OciError when an error occurs
|
|
957
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1022
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetUser.ts.html |here} to see how to use GetUser API.
|
|
958
1023
|
*/
|
|
959
1024
|
getUser(getUserRequest: requests.GetUserRequest): Promise<responses.GetUserResponse>;
|
|
960
1025
|
/**
|
|
961
1026
|
* Gets the specified UserGroupMembership's information.
|
|
1027
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
962
1028
|
* @param GetUserGroupMembershipRequest
|
|
963
1029
|
* @return GetUserGroupMembershipResponse
|
|
964
1030
|
* @throws OciError when an error occurs
|
|
965
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1031
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetUserGroupMembership.ts.html |here} to see how to use GetUserGroupMembership API.
|
|
966
1032
|
*/
|
|
967
1033
|
getUserGroupMembership(getUserGroupMembershipRequest: requests.GetUserGroupMembershipRequest): Promise<responses.GetUserGroupMembershipResponse>;
|
|
968
1034
|
/**
|
|
969
1035
|
* Gets the specified user's console password information. The returned object contains the user's OCID,
|
|
970
1036
|
* but not the password itself. The actual password is returned only when created or reset.
|
|
971
1037
|
*
|
|
1038
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
972
1039
|
* @param GetUserUIPasswordInformationRequest
|
|
973
1040
|
* @return GetUserUIPasswordInformationResponse
|
|
974
1041
|
* @throws OciError when an error occurs
|
|
975
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1042
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetUserUIPasswordInformation.ts.html |here} to see how to use GetUserUIPasswordInformation API.
|
|
976
1043
|
*/
|
|
977
1044
|
getUserUIPasswordInformation(getUserUIPasswordInformationRequest: requests.GetUserUIPasswordInformationRequest): Promise<responses.GetUserUIPasswordInformationResponse>;
|
|
978
1045
|
/**
|
|
979
1046
|
* Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header
|
|
980
1047
|
* for any asynchronous operation in the Identity and Access Management service.
|
|
981
1048
|
*
|
|
1049
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
982
1050
|
* @param GetWorkRequestRequest
|
|
983
1051
|
* @return GetWorkRequestResponse
|
|
984
1052
|
* @throws OciError when an error occurs
|
|
985
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1053
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
986
1054
|
*/
|
|
987
1055
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
988
1056
|
/**
|
|
@@ -991,20 +1059,22 @@ export declare class IdentityClient {
|
|
|
991
1059
|
Every user has permission to use this API call for *their own user ID*. An administrator in your
|
|
992
1060
|
* organization does not need to write a policy to give users this ability.
|
|
993
1061
|
*
|
|
1062
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
994
1063
|
* @param ListApiKeysRequest
|
|
995
1064
|
* @return ListApiKeysResponse
|
|
996
1065
|
* @throws OciError when an error occurs
|
|
997
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1066
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListApiKeys.ts.html |here} to see how to use ListApiKeys API.
|
|
998
1067
|
*/
|
|
999
1068
|
listApiKeys(listApiKeysRequest: requests.ListApiKeysRequest): Promise<responses.ListApiKeysResponse>;
|
|
1000
1069
|
/**
|
|
1001
1070
|
* Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not
|
|
1002
1071
|
* the token itself. The actual token is returned only upon creation.
|
|
1003
1072
|
*
|
|
1073
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1004
1074
|
* @param ListAuthTokensRequest
|
|
1005
1075
|
* @return ListAuthTokensResponse
|
|
1006
1076
|
* @throws OciError when an error occurs
|
|
1007
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1077
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListAuthTokens.ts.html |here} to see how to use ListAuthTokens API.
|
|
1008
1078
|
*/
|
|
1009
1079
|
listAuthTokens(listAuthTokensRequest: requests.ListAuthTokensRequest): Promise<responses.ListAuthTokensResponse>;
|
|
1010
1080
|
/**
|
|
@@ -1014,10 +1084,11 @@ export declare class IdentityClient {
|
|
|
1014
1084
|
* Note that the order of the results returned can change if availability domains are added or removed; therefore, do not
|
|
1015
1085
|
* create a dependency on the list order.
|
|
1016
1086
|
*
|
|
1087
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1017
1088
|
* @param ListAvailabilityDomainsRequest
|
|
1018
1089
|
* @return ListAvailabilityDomainsResponse
|
|
1019
1090
|
* @throws OciError when an error occurs
|
|
1020
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1091
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListAvailabilityDomains.ts.html |here} to see how to use ListAvailabilityDomains API.
|
|
1021
1092
|
*/
|
|
1022
1093
|
listAvailabilityDomains(listAvailabilityDomainsRequest: requests.ListAvailabilityDomainsRequest): Promise<responses.ListAvailabilityDomainsResponse>;
|
|
1023
1094
|
/**
|
|
@@ -1029,19 +1100,21 @@ export declare class IdentityClient {
|
|
|
1029
1100
|
* require an [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types,
|
|
1030
1101
|
* such as buckets, require you to provide other identifying information.
|
|
1031
1102
|
*
|
|
1103
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1032
1104
|
* @param ListBulkActionResourceTypesRequest
|
|
1033
1105
|
* @return ListBulkActionResourceTypesResponse
|
|
1034
1106
|
* @throws OciError when an error occurs
|
|
1035
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1107
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListBulkActionResourceTypes.ts.html |here} to see how to use ListBulkActionResourceTypes API.
|
|
1036
1108
|
*/
|
|
1037
1109
|
listBulkActionResourceTypes(listBulkActionResourceTypesRequest: requests.ListBulkActionResourceTypesRequest): Promise<responses.ListBulkActionResourceTypesResponse>;
|
|
1038
1110
|
/**
|
|
1039
1111
|
* Lists the resource types that support bulk tag editing.
|
|
1040
1112
|
*
|
|
1113
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1041
1114
|
* @param ListBulkEditTagsResourceTypesRequest
|
|
1042
1115
|
* @return ListBulkEditTagsResourceTypesResponse
|
|
1043
1116
|
* @throws OciError when an error occurs
|
|
1044
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1117
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListBulkEditTagsResourceTypes.ts.html |here} to see how to use ListBulkEditTagsResourceTypes API.
|
|
1045
1118
|
*/
|
|
1046
1119
|
listBulkEditTagsResourceTypes(listBulkEditTagsResourceTypesRequest: requests.ListBulkEditTagsResourceTypesRequest): Promise<responses.ListBulkEditTagsResourceTypesResponse>;
|
|
1047
1120
|
/**
|
|
@@ -1064,13 +1137,15 @@ export declare class IdentityClient {
|
|
|
1064
1137
|
* <p>
|
|
1065
1138
|
See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1066
1139
|
*
|
|
1140
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1067
1141
|
* @param ListCompartmentsRequest
|
|
1068
1142
|
* @return ListCompartmentsResponse
|
|
1069
1143
|
* @throws OciError when an error occurs
|
|
1070
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1144
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListCompartments.ts.html |here} to see how to use ListCompartments API.
|
|
1071
1145
|
*/
|
|
1072
1146
|
listCompartments(listCompartmentsRequest: requests.ListCompartmentsRequest): Promise<responses.ListCompartmentsResponse>;
|
|
1073
1147
|
/**
|
|
1148
|
+
* NOTE: This function is deprecated in favor of listCompartmentsRecordIterator function.
|
|
1074
1149
|
* Creates a new async iterator which will iterate over the models.Compartment objects
|
|
1075
1150
|
* contained in responses from the listCompartments operation. This iterator will fetch more data from the
|
|
1076
1151
|
* server as needed.
|
|
@@ -1079,23 +1154,41 @@ export declare class IdentityClient {
|
|
|
1079
1154
|
*/
|
|
1080
1155
|
listAllCompartments(request: requests.ListCompartmentsRequest): AsyncIterableIterator<model.Compartment>;
|
|
1081
1156
|
/**
|
|
1157
|
+
* NOTE: This function is deprecated in favor of listCompartmentsResponseIterator function.
|
|
1082
1158
|
* Creates a new async iterator which will iterate over the responses received from the listCompartments operation. This iterator
|
|
1083
1159
|
* will fetch more data from the server as needed.
|
|
1084
1160
|
*
|
|
1085
1161
|
* @param request a request which can be sent to the service operation
|
|
1086
1162
|
*/
|
|
1087
1163
|
listAllCompartmentsResponses(request: requests.ListCompartmentsRequest): AsyncIterableIterator<responses.ListCompartmentsResponse>;
|
|
1164
|
+
/**
|
|
1165
|
+
* Creates a new async iterator which will iterate over the models.Compartment objects
|
|
1166
|
+
* contained in responses from the listCompartments operation. This iterator will fetch more data from the
|
|
1167
|
+
* server as needed.
|
|
1168
|
+
*
|
|
1169
|
+
* @param request a request which can be sent to the service operation
|
|
1170
|
+
*/
|
|
1171
|
+
listCompartmentsRecordIterator(request: requests.ListCompartmentsRequest): AsyncIterableIterator<model.Compartment>;
|
|
1172
|
+
/**
|
|
1173
|
+
* Creates a new async iterator which will iterate over the responses received from the listCompartments operation. This iterator
|
|
1174
|
+
* will fetch more data from the server as needed.
|
|
1175
|
+
*
|
|
1176
|
+
* @param request a request which can be sent to the service operation
|
|
1177
|
+
*/
|
|
1178
|
+
listCompartmentsResponseIterator(request: requests.ListCompartmentsRequest): AsyncIterableIterator<responses.ListCompartmentsResponse>;
|
|
1088
1179
|
/**
|
|
1089
1180
|
* Lists all the tags enabled for cost-tracking in the specified tenancy. For information about
|
|
1090
1181
|
* cost-tracking tags, see [Using Cost-tracking Tags](https://docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#costs).
|
|
1091
1182
|
*
|
|
1183
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1092
1184
|
* @param ListCostTrackingTagsRequest
|
|
1093
1185
|
* @return ListCostTrackingTagsResponse
|
|
1094
1186
|
* @throws OciError when an error occurs
|
|
1095
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1187
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListCostTrackingTags.ts.html |here} to see how to use ListCostTrackingTags API.
|
|
1096
1188
|
*/
|
|
1097
1189
|
listCostTrackingTags(listCostTrackingTagsRequest: requests.ListCostTrackingTagsRequest): Promise<responses.ListCostTrackingTagsResponse>;
|
|
1098
1190
|
/**
|
|
1191
|
+
* NOTE: This function is deprecated in favor of listCostTrackingTagsRecordIterator function.
|
|
1099
1192
|
* Creates a new async iterator which will iterate over the models.Tag objects
|
|
1100
1193
|
* contained in responses from the listCostTrackingTags operation. This iterator will fetch more data from the
|
|
1101
1194
|
* server as needed.
|
|
@@ -1104,20 +1197,37 @@ export declare class IdentityClient {
|
|
|
1104
1197
|
*/
|
|
1105
1198
|
listAllCostTrackingTags(request: requests.ListCostTrackingTagsRequest): AsyncIterableIterator<model.Tag>;
|
|
1106
1199
|
/**
|
|
1200
|
+
* NOTE: This function is deprecated in favor of listCostTrackingTagsResponseIterator function.
|
|
1107
1201
|
* Creates a new async iterator which will iterate over the responses received from the listCostTrackingTags operation. This iterator
|
|
1108
1202
|
* will fetch more data from the server as needed.
|
|
1109
1203
|
*
|
|
1110
1204
|
* @param request a request which can be sent to the service operation
|
|
1111
1205
|
*/
|
|
1112
1206
|
listAllCostTrackingTagsResponses(request: requests.ListCostTrackingTagsRequest): AsyncIterableIterator<responses.ListCostTrackingTagsResponse>;
|
|
1207
|
+
/**
|
|
1208
|
+
* Creates a new async iterator which will iterate over the models.Tag objects
|
|
1209
|
+
* contained in responses from the listCostTrackingTags operation. This iterator will fetch more data from the
|
|
1210
|
+
* server as needed.
|
|
1211
|
+
*
|
|
1212
|
+
* @param request a request which can be sent to the service operation
|
|
1213
|
+
*/
|
|
1214
|
+
listCostTrackingTagsRecordIterator(request: requests.ListCostTrackingTagsRequest): AsyncIterableIterator<model.Tag>;
|
|
1215
|
+
/**
|
|
1216
|
+
* Creates a new async iterator which will iterate over the responses received from the listCostTrackingTags operation. This iterator
|
|
1217
|
+
* will fetch more data from the server as needed.
|
|
1218
|
+
*
|
|
1219
|
+
* @param request a request which can be sent to the service operation
|
|
1220
|
+
*/
|
|
1221
|
+
listCostTrackingTagsResponseIterator(request: requests.ListCostTrackingTagsRequest): AsyncIterableIterator<responses.ListCostTrackingTagsResponse>;
|
|
1113
1222
|
/**
|
|
1114
1223
|
* Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not
|
|
1115
1224
|
* the secret key itself. The actual secret key is returned only upon creation.
|
|
1116
1225
|
*
|
|
1226
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1117
1227
|
* @param ListCustomerSecretKeysRequest
|
|
1118
1228
|
* @return ListCustomerSecretKeysResponse
|
|
1119
1229
|
* @throws OciError when an error occurs
|
|
1120
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1230
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListCustomerSecretKeys.ts.html |here} to see how to use ListCustomerSecretKeys API.
|
|
1121
1231
|
*/
|
|
1122
1232
|
listCustomerSecretKeys(listCustomerSecretKeysRequest: requests.ListCustomerSecretKeysRequest): Promise<responses.ListCustomerSecretKeysResponse>;
|
|
1123
1233
|
/**
|
|
@@ -1125,13 +1235,15 @@ export declare class IdentityClient {
|
|
|
1125
1235
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1126
1236
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1127
1237
|
*
|
|
1238
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1128
1239
|
* @param ListDynamicGroupsRequest
|
|
1129
1240
|
* @return ListDynamicGroupsResponse
|
|
1130
1241
|
* @throws OciError when an error occurs
|
|
1131
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1242
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListDynamicGroups.ts.html |here} to see how to use ListDynamicGroups API.
|
|
1132
1243
|
*/
|
|
1133
1244
|
listDynamicGroups(listDynamicGroupsRequest: requests.ListDynamicGroupsRequest): Promise<responses.ListDynamicGroupsResponse>;
|
|
1134
1245
|
/**
|
|
1246
|
+
* NOTE: This function is deprecated in favor of listDynamicGroupsRecordIterator function.
|
|
1135
1247
|
* Creates a new async iterator which will iterate over the models.DynamicGroup objects
|
|
1136
1248
|
* contained in responses from the listDynamicGroups operation. This iterator will fetch more data from the
|
|
1137
1249
|
* server as needed.
|
|
@@ -1140,21 +1252,38 @@ export declare class IdentityClient {
|
|
|
1140
1252
|
*/
|
|
1141
1253
|
listAllDynamicGroups(request: requests.ListDynamicGroupsRequest): AsyncIterableIterator<model.DynamicGroup>;
|
|
1142
1254
|
/**
|
|
1255
|
+
* NOTE: This function is deprecated in favor of listDynamicGroupsResponseIterator function.
|
|
1143
1256
|
* Creates a new async iterator which will iterate over the responses received from the listDynamicGroups operation. This iterator
|
|
1144
1257
|
* will fetch more data from the server as needed.
|
|
1145
1258
|
*
|
|
1146
1259
|
* @param request a request which can be sent to the service operation
|
|
1147
1260
|
*/
|
|
1148
1261
|
listAllDynamicGroupsResponses(request: requests.ListDynamicGroupsRequest): AsyncIterableIterator<responses.ListDynamicGroupsResponse>;
|
|
1262
|
+
/**
|
|
1263
|
+
* Creates a new async iterator which will iterate over the models.DynamicGroup objects
|
|
1264
|
+
* contained in responses from the listDynamicGroups operation. This iterator will fetch more data from the
|
|
1265
|
+
* server as needed.
|
|
1266
|
+
*
|
|
1267
|
+
* @param request a request which can be sent to the service operation
|
|
1268
|
+
*/
|
|
1269
|
+
listDynamicGroupsRecordIterator(request: requests.ListDynamicGroupsRequest): AsyncIterableIterator<model.DynamicGroup>;
|
|
1270
|
+
/**
|
|
1271
|
+
* Creates a new async iterator which will iterate over the responses received from the listDynamicGroups operation. This iterator
|
|
1272
|
+
* will fetch more data from the server as needed.
|
|
1273
|
+
*
|
|
1274
|
+
* @param request a request which can be sent to the service operation
|
|
1275
|
+
*/
|
|
1276
|
+
listDynamicGroupsResponseIterator(request: requests.ListDynamicGroupsRequest): AsyncIterableIterator<responses.ListDynamicGroupsResponse>;
|
|
1149
1277
|
/**
|
|
1150
1278
|
* Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another
|
|
1151
1279
|
* of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1152
1280
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1153
1281
|
*
|
|
1282
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1154
1283
|
* @param ListFaultDomainsRequest
|
|
1155
1284
|
* @return ListFaultDomainsResponse
|
|
1156
1285
|
* @throws OciError when an error occurs
|
|
1157
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1286
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListFaultDomains.ts.html |here} to see how to use ListFaultDomains API.
|
|
1158
1287
|
*/
|
|
1159
1288
|
listFaultDomains(listFaultDomainsRequest: requests.ListFaultDomainsRequest): Promise<responses.ListFaultDomainsResponse>;
|
|
1160
1289
|
/**
|
|
@@ -1162,13 +1291,15 @@ export declare class IdentityClient {
|
|
|
1162
1291
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1163
1292
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1164
1293
|
*
|
|
1294
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1165
1295
|
* @param ListGroupsRequest
|
|
1166
1296
|
* @return ListGroupsResponse
|
|
1167
1297
|
* @throws OciError when an error occurs
|
|
1168
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1298
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListGroups.ts.html |here} to see how to use ListGroups API.
|
|
1169
1299
|
*/
|
|
1170
1300
|
listGroups(listGroupsRequest: requests.ListGroupsRequest): Promise<responses.ListGroupsResponse>;
|
|
1171
1301
|
/**
|
|
1302
|
+
* NOTE: This function is deprecated in favor of listGroupsRecordIterator function.
|
|
1172
1303
|
* Creates a new async iterator which will iterate over the models.Group objects
|
|
1173
1304
|
* contained in responses from the listGroups operation. This iterator will fetch more data from the
|
|
1174
1305
|
* server as needed.
|
|
@@ -1177,21 +1308,39 @@ export declare class IdentityClient {
|
|
|
1177
1308
|
*/
|
|
1178
1309
|
listAllGroups(request: requests.ListGroupsRequest): AsyncIterableIterator<model.Group>;
|
|
1179
1310
|
/**
|
|
1311
|
+
* NOTE: This function is deprecated in favor of listGroupsResponseIterator function.
|
|
1180
1312
|
* Creates a new async iterator which will iterate over the responses received from the listGroups operation. This iterator
|
|
1181
1313
|
* will fetch more data from the server as needed.
|
|
1182
1314
|
*
|
|
1183
1315
|
* @param request a request which can be sent to the service operation
|
|
1184
1316
|
*/
|
|
1185
1317
|
listAllGroupsResponses(request: requests.ListGroupsRequest): AsyncIterableIterator<responses.ListGroupsResponse>;
|
|
1318
|
+
/**
|
|
1319
|
+
* Creates a new async iterator which will iterate over the models.Group objects
|
|
1320
|
+
* contained in responses from the listGroups operation. This iterator will fetch more data from the
|
|
1321
|
+
* server as needed.
|
|
1322
|
+
*
|
|
1323
|
+
* @param request a request which can be sent to the service operation
|
|
1324
|
+
*/
|
|
1325
|
+
listGroupsRecordIterator(request: requests.ListGroupsRequest): AsyncIterableIterator<model.Group>;
|
|
1326
|
+
/**
|
|
1327
|
+
* Creates a new async iterator which will iterate over the responses received from the listGroups operation. This iterator
|
|
1328
|
+
* will fetch more data from the server as needed.
|
|
1329
|
+
*
|
|
1330
|
+
* @param request a request which can be sent to the service operation
|
|
1331
|
+
*/
|
|
1332
|
+
listGroupsResponseIterator(request: requests.ListGroupsRequest): AsyncIterableIterator<responses.ListGroupsResponse>;
|
|
1186
1333
|
/**
|
|
1187
1334
|
* Lists the identity provider groups.
|
|
1335
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1188
1336
|
* @param ListIdentityProviderGroupsRequest
|
|
1189
1337
|
* @return ListIdentityProviderGroupsResponse
|
|
1190
1338
|
* @throws OciError when an error occurs
|
|
1191
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1339
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListIdentityProviderGroups.ts.html |here} to see how to use ListIdentityProviderGroups API.
|
|
1192
1340
|
*/
|
|
1193
1341
|
listIdentityProviderGroups(listIdentityProviderGroupsRequest: requests.ListIdentityProviderGroupsRequest): Promise<responses.ListIdentityProviderGroupsResponse>;
|
|
1194
1342
|
/**
|
|
1343
|
+
* NOTE: This function is deprecated in favor of listIdentityProviderGroupsRecordIterator function.
|
|
1195
1344
|
* Creates a new async iterator which will iterate over the models.IdentityProviderGroupSummary objects
|
|
1196
1345
|
* contained in responses from the listIdentityProviderGroups operation. This iterator will fetch more data from the
|
|
1197
1346
|
* server as needed.
|
|
@@ -1200,25 +1349,43 @@ export declare class IdentityClient {
|
|
|
1200
1349
|
*/
|
|
1201
1350
|
listAllIdentityProviderGroups(request: requests.ListIdentityProviderGroupsRequest): AsyncIterableIterator<model.IdentityProviderGroupSummary>;
|
|
1202
1351
|
/**
|
|
1352
|
+
* NOTE: This function is deprecated in favor of listIdentityProviderGroupsResponseIterator function.
|
|
1203
1353
|
* Creates a new async iterator which will iterate over the responses received from the listIdentityProviderGroups operation. This iterator
|
|
1204
1354
|
* will fetch more data from the server as needed.
|
|
1205
1355
|
*
|
|
1206
1356
|
* @param request a request which can be sent to the service operation
|
|
1207
1357
|
*/
|
|
1208
1358
|
listAllIdentityProviderGroupsResponses(request: requests.ListIdentityProviderGroupsRequest): AsyncIterableIterator<responses.ListIdentityProviderGroupsResponse>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Creates a new async iterator which will iterate over the models.IdentityProviderGroupSummary objects
|
|
1361
|
+
* contained in responses from the listIdentityProviderGroups operation. This iterator will fetch more data from the
|
|
1362
|
+
* server as needed.
|
|
1363
|
+
*
|
|
1364
|
+
* @param request a request which can be sent to the service operation
|
|
1365
|
+
*/
|
|
1366
|
+
listIdentityProviderGroupsRecordIterator(request: requests.ListIdentityProviderGroupsRequest): AsyncIterableIterator<model.IdentityProviderGroupSummary>;
|
|
1367
|
+
/**
|
|
1368
|
+
* Creates a new async iterator which will iterate over the responses received from the listIdentityProviderGroups operation. This iterator
|
|
1369
|
+
* will fetch more data from the server as needed.
|
|
1370
|
+
*
|
|
1371
|
+
* @param request a request which can be sent to the service operation
|
|
1372
|
+
*/
|
|
1373
|
+
listIdentityProviderGroupsResponseIterator(request: requests.ListIdentityProviderGroupsRequest): AsyncIterableIterator<responses.ListIdentityProviderGroupsResponse>;
|
|
1209
1374
|
/**
|
|
1210
1375
|
* Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for
|
|
1211
1376
|
* identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the
|
|
1212
1377
|
* compartment ID (remember that the tenancy is simply the root compartment).
|
|
1213
1378
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1214
1379
|
*
|
|
1380
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1215
1381
|
* @param ListIdentityProvidersRequest
|
|
1216
1382
|
* @return ListIdentityProvidersResponse
|
|
1217
1383
|
* @throws OciError when an error occurs
|
|
1218
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1384
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListIdentityProviders.ts.html |here} to see how to use ListIdentityProviders API.
|
|
1219
1385
|
*/
|
|
1220
1386
|
listIdentityProviders(listIdentityProvidersRequest: requests.ListIdentityProvidersRequest): Promise<responses.ListIdentityProvidersResponse>;
|
|
1221
1387
|
/**
|
|
1388
|
+
* NOTE: This function is deprecated in favor of listIdentityProvidersRecordIterator function.
|
|
1222
1389
|
* Creates a new async iterator which will iterate over the models.IdentityProvider objects
|
|
1223
1390
|
* contained in responses from the listIdentityProviders operation. This iterator will fetch more data from the
|
|
1224
1391
|
* server as needed.
|
|
@@ -1227,22 +1394,40 @@ export declare class IdentityClient {
|
|
|
1227
1394
|
*/
|
|
1228
1395
|
listAllIdentityProviders(request: requests.ListIdentityProvidersRequest): AsyncIterableIterator<model.IdentityProvider>;
|
|
1229
1396
|
/**
|
|
1397
|
+
* NOTE: This function is deprecated in favor of listIdentityProvidersResponseIterator function.
|
|
1230
1398
|
* Creates a new async iterator which will iterate over the responses received from the listIdentityProviders operation. This iterator
|
|
1231
1399
|
* will fetch more data from the server as needed.
|
|
1232
1400
|
*
|
|
1233
1401
|
* @param request a request which can be sent to the service operation
|
|
1234
1402
|
*/
|
|
1235
1403
|
listAllIdentityProvidersResponses(request: requests.ListIdentityProvidersRequest): AsyncIterableIterator<responses.ListIdentityProvidersResponse>;
|
|
1404
|
+
/**
|
|
1405
|
+
* Creates a new async iterator which will iterate over the models.IdentityProvider objects
|
|
1406
|
+
* contained in responses from the listIdentityProviders operation. This iterator will fetch more data from the
|
|
1407
|
+
* server as needed.
|
|
1408
|
+
*
|
|
1409
|
+
* @param request a request which can be sent to the service operation
|
|
1410
|
+
*/
|
|
1411
|
+
listIdentityProvidersRecordIterator(request: requests.ListIdentityProvidersRequest): AsyncIterableIterator<model.IdentityProvider>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Creates a new async iterator which will iterate over the responses received from the listIdentityProviders operation. This iterator
|
|
1414
|
+
* will fetch more data from the server as needed.
|
|
1415
|
+
*
|
|
1416
|
+
* @param request a request which can be sent to the service operation
|
|
1417
|
+
*/
|
|
1418
|
+
listIdentityProvidersResponseIterator(request: requests.ListIdentityProvidersRequest): AsyncIterableIterator<responses.ListIdentityProvidersResponse>;
|
|
1236
1419
|
/**
|
|
1237
1420
|
* Lists the group mappings for the specified identity provider.
|
|
1238
1421
|
*
|
|
1422
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1239
1423
|
* @param ListIdpGroupMappingsRequest
|
|
1240
1424
|
* @return ListIdpGroupMappingsResponse
|
|
1241
1425
|
* @throws OciError when an error occurs
|
|
1242
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1426
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListIdpGroupMappings.ts.html |here} to see how to use ListIdpGroupMappings API.
|
|
1243
1427
|
*/
|
|
1244
1428
|
listIdpGroupMappings(listIdpGroupMappingsRequest: requests.ListIdpGroupMappingsRequest): Promise<responses.ListIdpGroupMappingsResponse>;
|
|
1245
1429
|
/**
|
|
1430
|
+
* NOTE: This function is deprecated in favor of listIdpGroupMappingsRecordIterator function.
|
|
1246
1431
|
* Creates a new async iterator which will iterate over the models.IdpGroupMapping objects
|
|
1247
1432
|
* contained in responses from the listIdpGroupMappings operation. This iterator will fetch more data from the
|
|
1248
1433
|
* server as needed.
|
|
@@ -1251,23 +1436,41 @@ export declare class IdentityClient {
|
|
|
1251
1436
|
*/
|
|
1252
1437
|
listAllIdpGroupMappings(request: requests.ListIdpGroupMappingsRequest): AsyncIterableIterator<model.IdpGroupMapping>;
|
|
1253
1438
|
/**
|
|
1439
|
+
* NOTE: This function is deprecated in favor of listIdpGroupMappingsResponseIterator function.
|
|
1254
1440
|
* Creates a new async iterator which will iterate over the responses received from the listIdpGroupMappings operation. This iterator
|
|
1255
1441
|
* will fetch more data from the server as needed.
|
|
1256
1442
|
*
|
|
1257
1443
|
* @param request a request which can be sent to the service operation
|
|
1258
1444
|
*/
|
|
1259
1445
|
listAllIdpGroupMappingsResponses(request: requests.ListIdpGroupMappingsRequest): AsyncIterableIterator<responses.ListIdpGroupMappingsResponse>;
|
|
1446
|
+
/**
|
|
1447
|
+
* Creates a new async iterator which will iterate over the models.IdpGroupMapping objects
|
|
1448
|
+
* contained in responses from the listIdpGroupMappings operation. This iterator will fetch more data from the
|
|
1449
|
+
* server as needed.
|
|
1450
|
+
*
|
|
1451
|
+
* @param request a request which can be sent to the service operation
|
|
1452
|
+
*/
|
|
1453
|
+
listIdpGroupMappingsRecordIterator(request: requests.ListIdpGroupMappingsRequest): AsyncIterableIterator<model.IdpGroupMapping>;
|
|
1454
|
+
/**
|
|
1455
|
+
* Creates a new async iterator which will iterate over the responses received from the listIdpGroupMappings operation. This iterator
|
|
1456
|
+
* will fetch more data from the server as needed.
|
|
1457
|
+
*
|
|
1458
|
+
* @param request a request which can be sent to the service operation
|
|
1459
|
+
*/
|
|
1460
|
+
listIdpGroupMappingsResponseIterator(request: requests.ListIdpGroupMappingsRequest): AsyncIterableIterator<responses.ListIdpGroupMappingsResponse>;
|
|
1260
1461
|
/**
|
|
1261
1462
|
* Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not
|
|
1262
1463
|
* the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.
|
|
1263
1464
|
*
|
|
1465
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1264
1466
|
* @param ListMfaTotpDevicesRequest
|
|
1265
1467
|
* @return ListMfaTotpDevicesResponse
|
|
1266
1468
|
* @throws OciError when an error occurs
|
|
1267
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1469
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListMfaTotpDevices.ts.html |here} to see how to use ListMfaTotpDevices API.
|
|
1268
1470
|
*/
|
|
1269
1471
|
listMfaTotpDevices(listMfaTotpDevicesRequest: requests.ListMfaTotpDevicesRequest): Promise<responses.ListMfaTotpDevicesResponse>;
|
|
1270
1472
|
/**
|
|
1473
|
+
* NOTE: This function is deprecated in favor of listMfaTotpDevicesRecordIterator function.
|
|
1271
1474
|
* Creates a new async iterator which will iterate over the models.MfaTotpDeviceSummary objects
|
|
1272
1475
|
* contained in responses from the listMfaTotpDevices operation. This iterator will fetch more data from the
|
|
1273
1476
|
* server as needed.
|
|
@@ -1276,24 +1479,42 @@ export declare class IdentityClient {
|
|
|
1276
1479
|
*/
|
|
1277
1480
|
listAllMfaTotpDevices(request: requests.ListMfaTotpDevicesRequest): AsyncIterableIterator<model.MfaTotpDeviceSummary>;
|
|
1278
1481
|
/**
|
|
1482
|
+
* NOTE: This function is deprecated in favor of listMfaTotpDevicesResponseIterator function.
|
|
1279
1483
|
* Creates a new async iterator which will iterate over the responses received from the listMfaTotpDevices operation. This iterator
|
|
1280
1484
|
* will fetch more data from the server as needed.
|
|
1281
1485
|
*
|
|
1282
1486
|
* @param request a request which can be sent to the service operation
|
|
1283
1487
|
*/
|
|
1284
1488
|
listAllMfaTotpDevicesResponses(request: requests.ListMfaTotpDevicesRequest): AsyncIterableIterator<responses.ListMfaTotpDevicesResponse>;
|
|
1489
|
+
/**
|
|
1490
|
+
* Creates a new async iterator which will iterate over the models.MfaTotpDeviceSummary objects
|
|
1491
|
+
* contained in responses from the listMfaTotpDevices operation. This iterator will fetch more data from the
|
|
1492
|
+
* server as needed.
|
|
1493
|
+
*
|
|
1494
|
+
* @param request a request which can be sent to the service operation
|
|
1495
|
+
*/
|
|
1496
|
+
listMfaTotpDevicesRecordIterator(request: requests.ListMfaTotpDevicesRequest): AsyncIterableIterator<model.MfaTotpDeviceSummary>;
|
|
1497
|
+
/**
|
|
1498
|
+
* Creates a new async iterator which will iterate over the responses received from the listMfaTotpDevices operation. This iterator
|
|
1499
|
+
* will fetch more data from the server as needed.
|
|
1500
|
+
*
|
|
1501
|
+
* @param request a request which can be sent to the service operation
|
|
1502
|
+
*/
|
|
1503
|
+
listMfaTotpDevicesResponseIterator(request: requests.ListMfaTotpDevicesRequest): AsyncIterableIterator<responses.ListMfaTotpDevicesResponse>;
|
|
1285
1504
|
/**
|
|
1286
1505
|
* Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for
|
|
1287
1506
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1288
1507
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1289
1508
|
*
|
|
1509
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1290
1510
|
* @param ListNetworkSourcesRequest
|
|
1291
1511
|
* @return ListNetworkSourcesResponse
|
|
1292
1512
|
* @throws OciError when an error occurs
|
|
1293
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1513
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListNetworkSources.ts.html |here} to see how to use ListNetworkSources API.
|
|
1294
1514
|
*/
|
|
1295
1515
|
listNetworkSources(listNetworkSourcesRequest: requests.ListNetworkSourcesRequest): Promise<responses.ListNetworkSourcesResponse>;
|
|
1296
1516
|
/**
|
|
1517
|
+
* NOTE: This function is deprecated in favor of listNetworkSourcesRecordIterator function.
|
|
1297
1518
|
* Creates a new async iterator which will iterate over the models.NetworkSourcesSummary objects
|
|
1298
1519
|
* contained in responses from the listNetworkSources operation. This iterator will fetch more data from the
|
|
1299
1520
|
* server as needed.
|
|
@@ -1302,22 +1523,40 @@ export declare class IdentityClient {
|
|
|
1302
1523
|
*/
|
|
1303
1524
|
listAllNetworkSources(request: requests.ListNetworkSourcesRequest): AsyncIterableIterator<model.NetworkSourcesSummary>;
|
|
1304
1525
|
/**
|
|
1526
|
+
* NOTE: This function is deprecated in favor of listNetworkSourcesResponseIterator function.
|
|
1305
1527
|
* Creates a new async iterator which will iterate over the responses received from the listNetworkSources operation. This iterator
|
|
1306
1528
|
* will fetch more data from the server as needed.
|
|
1307
1529
|
*
|
|
1308
1530
|
* @param request a request which can be sent to the service operation
|
|
1309
1531
|
*/
|
|
1310
1532
|
listAllNetworkSourcesResponses(request: requests.ListNetworkSourcesRequest): AsyncIterableIterator<responses.ListNetworkSourcesResponse>;
|
|
1533
|
+
/**
|
|
1534
|
+
* Creates a new async iterator which will iterate over the models.NetworkSourcesSummary objects
|
|
1535
|
+
* contained in responses from the listNetworkSources operation. This iterator will fetch more data from the
|
|
1536
|
+
* server as needed.
|
|
1537
|
+
*
|
|
1538
|
+
* @param request a request which can be sent to the service operation
|
|
1539
|
+
*/
|
|
1540
|
+
listNetworkSourcesRecordIterator(request: requests.ListNetworkSourcesRequest): AsyncIterableIterator<model.NetworkSourcesSummary>;
|
|
1541
|
+
/**
|
|
1542
|
+
* Creates a new async iterator which will iterate over the responses received from the listNetworkSources operation. This iterator
|
|
1543
|
+
* will fetch more data from the server as needed.
|
|
1544
|
+
*
|
|
1545
|
+
* @param request a request which can be sent to the service operation
|
|
1546
|
+
*/
|
|
1547
|
+
listNetworkSourcesResponseIterator(request: requests.ListNetworkSourcesRequest): AsyncIterableIterator<responses.ListNetworkSourcesResponse>;
|
|
1311
1548
|
/**
|
|
1312
1549
|
* List of Oauth tokens for the user
|
|
1313
1550
|
*
|
|
1551
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1314
1552
|
* @param ListOAuthClientCredentialsRequest
|
|
1315
1553
|
* @return ListOAuthClientCredentialsResponse
|
|
1316
1554
|
* @throws OciError when an error occurs
|
|
1317
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1555
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListOAuthClientCredentials.ts.html |here} to see how to use ListOAuthClientCredentials API.
|
|
1318
1556
|
*/
|
|
1319
1557
|
listOAuthClientCredentials(listOAuthClientCredentialsRequest: requests.ListOAuthClientCredentialsRequest): Promise<responses.ListOAuthClientCredentialsResponse>;
|
|
1320
1558
|
/**
|
|
1559
|
+
* NOTE: This function is deprecated in favor of listOAuthClientCredentialsRecordIterator function.
|
|
1321
1560
|
* Creates a new async iterator which will iterate over the models.OAuth2ClientCredentialSummary objects
|
|
1322
1561
|
* contained in responses from the listOAuthClientCredentials operation. This iterator will fetch more data from the
|
|
1323
1562
|
* server as needed.
|
|
@@ -1326,12 +1565,28 @@ export declare class IdentityClient {
|
|
|
1326
1565
|
*/
|
|
1327
1566
|
listAllOAuthClientCredentials(request: requests.ListOAuthClientCredentialsRequest): AsyncIterableIterator<model.OAuth2ClientCredentialSummary>;
|
|
1328
1567
|
/**
|
|
1568
|
+
* NOTE: This function is deprecated in favor of listOAuthClientCredentialsResponseIterator function.
|
|
1329
1569
|
* Creates a new async iterator which will iterate over the responses received from the listOAuthClientCredentials operation. This iterator
|
|
1330
1570
|
* will fetch more data from the server as needed.
|
|
1331
1571
|
*
|
|
1332
1572
|
* @param request a request which can be sent to the service operation
|
|
1333
1573
|
*/
|
|
1334
1574
|
listAllOAuthClientCredentialsResponses(request: requests.ListOAuthClientCredentialsRequest): AsyncIterableIterator<responses.ListOAuthClientCredentialsResponse>;
|
|
1575
|
+
/**
|
|
1576
|
+
* Creates a new async iterator which will iterate over the models.OAuth2ClientCredentialSummary objects
|
|
1577
|
+
* contained in responses from the listOAuthClientCredentials operation. This iterator will fetch more data from the
|
|
1578
|
+
* server as needed.
|
|
1579
|
+
*
|
|
1580
|
+
* @param request a request which can be sent to the service operation
|
|
1581
|
+
*/
|
|
1582
|
+
listOAuthClientCredentialsRecordIterator(request: requests.ListOAuthClientCredentialsRequest): AsyncIterableIterator<model.OAuth2ClientCredentialSummary>;
|
|
1583
|
+
/**
|
|
1584
|
+
* Creates a new async iterator which will iterate over the responses received from the listOAuthClientCredentials operation. This iterator
|
|
1585
|
+
* will fetch more data from the server as needed.
|
|
1586
|
+
*
|
|
1587
|
+
* @param request a request which can be sent to the service operation
|
|
1588
|
+
*/
|
|
1589
|
+
listOAuthClientCredentialsResponseIterator(request: requests.ListOAuthClientCredentialsRequest): AsyncIterableIterator<responses.ListOAuthClientCredentialsResponse>;
|
|
1335
1590
|
/**
|
|
1336
1591
|
* Lists the policies in the specified compartment (either the tenancy or another of your compartments).
|
|
1337
1592
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
@@ -1339,13 +1594,15 @@ export declare class IdentityClient {
|
|
|
1339
1594
|
To determine which policies apply to a particular group or compartment, you must view the individual
|
|
1340
1595
|
* statements inside all your policies. There isn't a way to automatically obtain that information via the API.
|
|
1341
1596
|
*
|
|
1597
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1342
1598
|
* @param ListPoliciesRequest
|
|
1343
1599
|
* @return ListPoliciesResponse
|
|
1344
1600
|
* @throws OciError when an error occurs
|
|
1345
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1601
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListPolicies.ts.html |here} to see how to use ListPolicies API.
|
|
1346
1602
|
*/
|
|
1347
1603
|
listPolicies(listPoliciesRequest: requests.ListPoliciesRequest): Promise<responses.ListPoliciesResponse>;
|
|
1348
1604
|
/**
|
|
1605
|
+
* NOTE: This function is deprecated in favor of listPoliciesRecordIterator function.
|
|
1349
1606
|
* Creates a new async iterator which will iterate over the models.Policy objects
|
|
1350
1607
|
* contained in responses from the listPolicies operation. This iterator will fetch more data from the
|
|
1351
1608
|
* server as needed.
|
|
@@ -1354,36 +1611,55 @@ export declare class IdentityClient {
|
|
|
1354
1611
|
*/
|
|
1355
1612
|
listAllPolicies(request: requests.ListPoliciesRequest): AsyncIterableIterator<model.Policy>;
|
|
1356
1613
|
/**
|
|
1614
|
+
* NOTE: This function is deprecated in favor of listPoliciesResponseIterator function.
|
|
1357
1615
|
* Creates a new async iterator which will iterate over the responses received from the listPolicies operation. This iterator
|
|
1358
1616
|
* will fetch more data from the server as needed.
|
|
1359
1617
|
*
|
|
1360
1618
|
* @param request a request which can be sent to the service operation
|
|
1361
1619
|
*/
|
|
1362
1620
|
listAllPoliciesResponses(request: requests.ListPoliciesRequest): AsyncIterableIterator<responses.ListPoliciesResponse>;
|
|
1621
|
+
/**
|
|
1622
|
+
* Creates a new async iterator which will iterate over the models.Policy objects
|
|
1623
|
+
* contained in responses from the listPolicies operation. This iterator will fetch more data from the
|
|
1624
|
+
* server as needed.
|
|
1625
|
+
*
|
|
1626
|
+
* @param request a request which can be sent to the service operation
|
|
1627
|
+
*/
|
|
1628
|
+
listPoliciesRecordIterator(request: requests.ListPoliciesRequest): AsyncIterableIterator<model.Policy>;
|
|
1629
|
+
/**
|
|
1630
|
+
* Creates a new async iterator which will iterate over the responses received from the listPolicies operation. This iterator
|
|
1631
|
+
* will fetch more data from the server as needed.
|
|
1632
|
+
*
|
|
1633
|
+
* @param request a request which can be sent to the service operation
|
|
1634
|
+
*/
|
|
1635
|
+
listPoliciesResponseIterator(request: requests.ListPoliciesRequest): AsyncIterableIterator<responses.ListPoliciesResponse>;
|
|
1363
1636
|
/**
|
|
1364
1637
|
* Lists the region subscriptions for the specified tenancy.
|
|
1638
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1365
1639
|
* @param ListRegionSubscriptionsRequest
|
|
1366
1640
|
* @return ListRegionSubscriptionsResponse
|
|
1367
1641
|
* @throws OciError when an error occurs
|
|
1368
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1642
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListRegionSubscriptions.ts.html |here} to see how to use ListRegionSubscriptions API.
|
|
1369
1643
|
*/
|
|
1370
1644
|
listRegionSubscriptions(listRegionSubscriptionsRequest: requests.ListRegionSubscriptionsRequest): Promise<responses.ListRegionSubscriptionsResponse>;
|
|
1371
1645
|
/**
|
|
1372
1646
|
* Lists all the regions offered by Oracle Cloud Infrastructure.
|
|
1647
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1373
1648
|
* @param ListRegionsRequest
|
|
1374
1649
|
* @return ListRegionsResponse
|
|
1375
1650
|
* @throws OciError when an error occurs
|
|
1376
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1651
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListRegions.ts.html |here} to see how to use ListRegions API.
|
|
1377
1652
|
*/
|
|
1378
1653
|
listRegions(listRegionsRequest: requests.ListRegionsRequest): Promise<responses.ListRegionsResponse>;
|
|
1379
1654
|
/**
|
|
1380
1655
|
* Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,
|
|
1381
1656
|
* the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.
|
|
1382
1657
|
*
|
|
1658
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1383
1659
|
* @param ListSmtpCredentialsRequest
|
|
1384
1660
|
* @return ListSmtpCredentialsResponse
|
|
1385
1661
|
* @throws OciError when an error occurs
|
|
1386
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1662
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListSmtpCredentials.ts.html |here} to see how to use ListSmtpCredentials API.
|
|
1387
1663
|
*/
|
|
1388
1664
|
listSmtpCredentials(listSmtpCredentialsRequest: requests.ListSmtpCredentialsRequest): Promise<responses.ListSmtpCredentialsResponse>;
|
|
1389
1665
|
/**
|
|
@@ -1392,22 +1668,25 @@ export declare class IdentityClient {
|
|
|
1392
1668
|
Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not
|
|
1393
1669
|
* the password itself. The actual password is returned only upon creation.
|
|
1394
1670
|
*
|
|
1671
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1395
1672
|
* @param ListSwiftPasswordsRequest
|
|
1396
1673
|
* @return ListSwiftPasswordsResponse
|
|
1397
1674
|
* @throws OciError when an error occurs
|
|
1398
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1675
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListSwiftPasswords.ts.html |here} to see how to use ListSwiftPasswords API.
|
|
1399
1676
|
*/
|
|
1400
1677
|
listSwiftPasswords(listSwiftPasswordsRequest: requests.ListSwiftPasswordsRequest): Promise<responses.ListSwiftPasswordsResponse>;
|
|
1401
1678
|
/**
|
|
1402
1679
|
* Lists the tag defaults for tag definitions in the specified compartment.
|
|
1403
1680
|
*
|
|
1681
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1404
1682
|
* @param ListTagDefaultsRequest
|
|
1405
1683
|
* @return ListTagDefaultsResponse
|
|
1406
1684
|
* @throws OciError when an error occurs
|
|
1407
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1685
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListTagDefaults.ts.html |here} to see how to use ListTagDefaults API.
|
|
1408
1686
|
*/
|
|
1409
1687
|
listTagDefaults(listTagDefaultsRequest: requests.ListTagDefaultsRequest): Promise<responses.ListTagDefaultsResponse>;
|
|
1410
1688
|
/**
|
|
1689
|
+
* NOTE: This function is deprecated in favor of listTagDefaultsRecordIterator function.
|
|
1411
1690
|
* Creates a new async iterator which will iterate over the models.TagDefaultSummary objects
|
|
1412
1691
|
* contained in responses from the listTagDefaults operation. This iterator will fetch more data from the
|
|
1413
1692
|
* server as needed.
|
|
@@ -1416,22 +1695,40 @@ export declare class IdentityClient {
|
|
|
1416
1695
|
*/
|
|
1417
1696
|
listAllTagDefaults(request: requests.ListTagDefaultsRequest): AsyncIterableIterator<model.TagDefaultSummary>;
|
|
1418
1697
|
/**
|
|
1698
|
+
* NOTE: This function is deprecated in favor of listTagDefaultsResponseIterator function.
|
|
1419
1699
|
* Creates a new async iterator which will iterate over the responses received from the listTagDefaults operation. This iterator
|
|
1420
1700
|
* will fetch more data from the server as needed.
|
|
1421
1701
|
*
|
|
1422
1702
|
* @param request a request which can be sent to the service operation
|
|
1423
1703
|
*/
|
|
1424
1704
|
listAllTagDefaultsResponses(request: requests.ListTagDefaultsRequest): AsyncIterableIterator<responses.ListTagDefaultsResponse>;
|
|
1705
|
+
/**
|
|
1706
|
+
* Creates a new async iterator which will iterate over the models.TagDefaultSummary objects
|
|
1707
|
+
* contained in responses from the listTagDefaults operation. This iterator will fetch more data from the
|
|
1708
|
+
* server as needed.
|
|
1709
|
+
*
|
|
1710
|
+
* @param request a request which can be sent to the service operation
|
|
1711
|
+
*/
|
|
1712
|
+
listTagDefaultsRecordIterator(request: requests.ListTagDefaultsRequest): AsyncIterableIterator<model.TagDefaultSummary>;
|
|
1713
|
+
/**
|
|
1714
|
+
* Creates a new async iterator which will iterate over the responses received from the listTagDefaults operation. This iterator
|
|
1715
|
+
* will fetch more data from the server as needed.
|
|
1716
|
+
*
|
|
1717
|
+
* @param request a request which can be sent to the service operation
|
|
1718
|
+
*/
|
|
1719
|
+
listTagDefaultsResponseIterator(request: requests.ListTagDefaultsRequest): AsyncIterableIterator<responses.ListTagDefaultsResponse>;
|
|
1425
1720
|
/**
|
|
1426
1721
|
* Lists the tag namespaces in the specified compartment.
|
|
1427
1722
|
*
|
|
1723
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1428
1724
|
* @param ListTagNamespacesRequest
|
|
1429
1725
|
* @return ListTagNamespacesResponse
|
|
1430
1726
|
* @throws OciError when an error occurs
|
|
1431
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1727
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListTagNamespaces.ts.html |here} to see how to use ListTagNamespaces API.
|
|
1432
1728
|
*/
|
|
1433
1729
|
listTagNamespaces(listTagNamespacesRequest: requests.ListTagNamespacesRequest): Promise<responses.ListTagNamespacesResponse>;
|
|
1434
1730
|
/**
|
|
1731
|
+
* NOTE: This function is deprecated in favor of listTagNamespacesRecordIterator function.
|
|
1435
1732
|
* Creates a new async iterator which will iterate over the models.TagNamespaceSummary objects
|
|
1436
1733
|
* contained in responses from the listTagNamespaces operation. This iterator will fetch more data from the
|
|
1437
1734
|
* server as needed.
|
|
@@ -1440,22 +1737,40 @@ export declare class IdentityClient {
|
|
|
1440
1737
|
*/
|
|
1441
1738
|
listAllTagNamespaces(request: requests.ListTagNamespacesRequest): AsyncIterableIterator<model.TagNamespaceSummary>;
|
|
1442
1739
|
/**
|
|
1740
|
+
* NOTE: This function is deprecated in favor of listTagNamespacesResponseIterator function.
|
|
1443
1741
|
* Creates a new async iterator which will iterate over the responses received from the listTagNamespaces operation. This iterator
|
|
1444
1742
|
* will fetch more data from the server as needed.
|
|
1445
1743
|
*
|
|
1446
1744
|
* @param request a request which can be sent to the service operation
|
|
1447
1745
|
*/
|
|
1448
1746
|
listAllTagNamespacesResponses(request: requests.ListTagNamespacesRequest): AsyncIterableIterator<responses.ListTagNamespacesResponse>;
|
|
1747
|
+
/**
|
|
1748
|
+
* Creates a new async iterator which will iterate over the models.TagNamespaceSummary objects
|
|
1749
|
+
* contained in responses from the listTagNamespaces operation. This iterator will fetch more data from the
|
|
1750
|
+
* server as needed.
|
|
1751
|
+
*
|
|
1752
|
+
* @param request a request which can be sent to the service operation
|
|
1753
|
+
*/
|
|
1754
|
+
listTagNamespacesRecordIterator(request: requests.ListTagNamespacesRequest): AsyncIterableIterator<model.TagNamespaceSummary>;
|
|
1755
|
+
/**
|
|
1756
|
+
* Creates a new async iterator which will iterate over the responses received from the listTagNamespaces operation. This iterator
|
|
1757
|
+
* will fetch more data from the server as needed.
|
|
1758
|
+
*
|
|
1759
|
+
* @param request a request which can be sent to the service operation
|
|
1760
|
+
*/
|
|
1761
|
+
listTagNamespacesResponseIterator(request: requests.ListTagNamespacesRequest): AsyncIterableIterator<responses.ListTagNamespacesResponse>;
|
|
1449
1762
|
/**
|
|
1450
1763
|
* Gets the errors for a work request.
|
|
1451
1764
|
*
|
|
1765
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1452
1766
|
* @param ListTaggingWorkRequestErrorsRequest
|
|
1453
1767
|
* @return ListTaggingWorkRequestErrorsResponse
|
|
1454
1768
|
* @throws OciError when an error occurs
|
|
1455
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1769
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListTaggingWorkRequestErrors.ts.html |here} to see how to use ListTaggingWorkRequestErrors API.
|
|
1456
1770
|
*/
|
|
1457
1771
|
listTaggingWorkRequestErrors(listTaggingWorkRequestErrorsRequest: requests.ListTaggingWorkRequestErrorsRequest): Promise<responses.ListTaggingWorkRequestErrorsResponse>;
|
|
1458
1772
|
/**
|
|
1773
|
+
* NOTE: This function is deprecated in favor of listTaggingWorkRequestErrorsRecordIterator function.
|
|
1459
1774
|
* Creates a new async iterator which will iterate over the models.TaggingWorkRequestErrorSummary objects
|
|
1460
1775
|
* contained in responses from the listTaggingWorkRequestErrors operation. This iterator will fetch more data from the
|
|
1461
1776
|
* server as needed.
|
|
@@ -1464,22 +1779,40 @@ export declare class IdentityClient {
|
|
|
1464
1779
|
*/
|
|
1465
1780
|
listAllTaggingWorkRequestErrors(request: requests.ListTaggingWorkRequestErrorsRequest): AsyncIterableIterator<model.TaggingWorkRequestErrorSummary>;
|
|
1466
1781
|
/**
|
|
1782
|
+
* NOTE: This function is deprecated in favor of listTaggingWorkRequestErrorsResponseIterator function.
|
|
1467
1783
|
* Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequestErrors operation. This iterator
|
|
1468
1784
|
* will fetch more data from the server as needed.
|
|
1469
1785
|
*
|
|
1470
1786
|
* @param request a request which can be sent to the service operation
|
|
1471
1787
|
*/
|
|
1472
1788
|
listAllTaggingWorkRequestErrorsResponses(request: requests.ListTaggingWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListTaggingWorkRequestErrorsResponse>;
|
|
1789
|
+
/**
|
|
1790
|
+
* Creates a new async iterator which will iterate over the models.TaggingWorkRequestErrorSummary objects
|
|
1791
|
+
* contained in responses from the listTaggingWorkRequestErrors operation. This iterator will fetch more data from the
|
|
1792
|
+
* server as needed.
|
|
1793
|
+
*
|
|
1794
|
+
* @param request a request which can be sent to the service operation
|
|
1795
|
+
*/
|
|
1796
|
+
listTaggingWorkRequestErrorsRecordIterator(request: requests.ListTaggingWorkRequestErrorsRequest): AsyncIterableIterator<model.TaggingWorkRequestErrorSummary>;
|
|
1797
|
+
/**
|
|
1798
|
+
* Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequestErrors operation. This iterator
|
|
1799
|
+
* will fetch more data from the server as needed.
|
|
1800
|
+
*
|
|
1801
|
+
* @param request a request which can be sent to the service operation
|
|
1802
|
+
*/
|
|
1803
|
+
listTaggingWorkRequestErrorsResponseIterator(request: requests.ListTaggingWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListTaggingWorkRequestErrorsResponse>;
|
|
1473
1804
|
/**
|
|
1474
1805
|
* Gets the logs for a work request.
|
|
1475
1806
|
*
|
|
1807
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1476
1808
|
* @param ListTaggingWorkRequestLogsRequest
|
|
1477
1809
|
* @return ListTaggingWorkRequestLogsResponse
|
|
1478
1810
|
* @throws OciError when an error occurs
|
|
1479
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1811
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListTaggingWorkRequestLogs.ts.html |here} to see how to use ListTaggingWorkRequestLogs API.
|
|
1480
1812
|
*/
|
|
1481
1813
|
listTaggingWorkRequestLogs(listTaggingWorkRequestLogsRequest: requests.ListTaggingWorkRequestLogsRequest): Promise<responses.ListTaggingWorkRequestLogsResponse>;
|
|
1482
1814
|
/**
|
|
1815
|
+
* NOTE: This function is deprecated in favor of listTaggingWorkRequestLogsRecordIterator function.
|
|
1483
1816
|
* Creates a new async iterator which will iterate over the models.TaggingWorkRequestLogSummary objects
|
|
1484
1817
|
* contained in responses from the listTaggingWorkRequestLogs operation. This iterator will fetch more data from the
|
|
1485
1818
|
* server as needed.
|
|
@@ -1488,22 +1821,40 @@ export declare class IdentityClient {
|
|
|
1488
1821
|
*/
|
|
1489
1822
|
listAllTaggingWorkRequestLogs(request: requests.ListTaggingWorkRequestLogsRequest): AsyncIterableIterator<model.TaggingWorkRequestLogSummary>;
|
|
1490
1823
|
/**
|
|
1824
|
+
* NOTE: This function is deprecated in favor of listTaggingWorkRequestLogsResponseIterator function.
|
|
1491
1825
|
* Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequestLogs operation. This iterator
|
|
1492
1826
|
* will fetch more data from the server as needed.
|
|
1493
1827
|
*
|
|
1494
1828
|
* @param request a request which can be sent to the service operation
|
|
1495
1829
|
*/
|
|
1496
1830
|
listAllTaggingWorkRequestLogsResponses(request: requests.ListTaggingWorkRequestLogsRequest): AsyncIterableIterator<responses.ListTaggingWorkRequestLogsResponse>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Creates a new async iterator which will iterate over the models.TaggingWorkRequestLogSummary objects
|
|
1833
|
+
* contained in responses from the listTaggingWorkRequestLogs operation. This iterator will fetch more data from the
|
|
1834
|
+
* server as needed.
|
|
1835
|
+
*
|
|
1836
|
+
* @param request a request which can be sent to the service operation
|
|
1837
|
+
*/
|
|
1838
|
+
listTaggingWorkRequestLogsRecordIterator(request: requests.ListTaggingWorkRequestLogsRequest): AsyncIterableIterator<model.TaggingWorkRequestLogSummary>;
|
|
1839
|
+
/**
|
|
1840
|
+
* Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequestLogs operation. This iterator
|
|
1841
|
+
* will fetch more data from the server as needed.
|
|
1842
|
+
*
|
|
1843
|
+
* @param request a request which can be sent to the service operation
|
|
1844
|
+
*/
|
|
1845
|
+
listTaggingWorkRequestLogsResponseIterator(request: requests.ListTaggingWorkRequestLogsRequest): AsyncIterableIterator<responses.ListTaggingWorkRequestLogsResponse>;
|
|
1497
1846
|
/**
|
|
1498
1847
|
* Lists the tagging work requests in compartment.
|
|
1499
1848
|
*
|
|
1849
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1500
1850
|
* @param ListTaggingWorkRequestsRequest
|
|
1501
1851
|
* @return ListTaggingWorkRequestsResponse
|
|
1502
1852
|
* @throws OciError when an error occurs
|
|
1503
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1853
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListTaggingWorkRequests.ts.html |here} to see how to use ListTaggingWorkRequests API.
|
|
1504
1854
|
*/
|
|
1505
1855
|
listTaggingWorkRequests(listTaggingWorkRequestsRequest: requests.ListTaggingWorkRequestsRequest): Promise<responses.ListTaggingWorkRequestsResponse>;
|
|
1506
1856
|
/**
|
|
1857
|
+
* NOTE: This function is deprecated in favor of listTaggingWorkRequestsRecordIterator function.
|
|
1507
1858
|
* Creates a new async iterator which will iterate over the models.TaggingWorkRequestSummary objects
|
|
1508
1859
|
* contained in responses from the listTaggingWorkRequests operation. This iterator will fetch more data from the
|
|
1509
1860
|
* server as needed.
|
|
@@ -1512,22 +1863,40 @@ export declare class IdentityClient {
|
|
|
1512
1863
|
*/
|
|
1513
1864
|
listAllTaggingWorkRequests(request: requests.ListTaggingWorkRequestsRequest): AsyncIterableIterator<model.TaggingWorkRequestSummary>;
|
|
1514
1865
|
/**
|
|
1866
|
+
* NOTE: This function is deprecated in favor of listTaggingWorkRequestsResponseIterator function.
|
|
1515
1867
|
* Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequests operation. This iterator
|
|
1516
1868
|
* will fetch more data from the server as needed.
|
|
1517
1869
|
*
|
|
1518
1870
|
* @param request a request which can be sent to the service operation
|
|
1519
1871
|
*/
|
|
1520
1872
|
listAllTaggingWorkRequestsResponses(request: requests.ListTaggingWorkRequestsRequest): AsyncIterableIterator<responses.ListTaggingWorkRequestsResponse>;
|
|
1873
|
+
/**
|
|
1874
|
+
* Creates a new async iterator which will iterate over the models.TaggingWorkRequestSummary objects
|
|
1875
|
+
* contained in responses from the listTaggingWorkRequests operation. This iterator will fetch more data from the
|
|
1876
|
+
* server as needed.
|
|
1877
|
+
*
|
|
1878
|
+
* @param request a request which can be sent to the service operation
|
|
1879
|
+
*/
|
|
1880
|
+
listTaggingWorkRequestsRecordIterator(request: requests.ListTaggingWorkRequestsRequest): AsyncIterableIterator<model.TaggingWorkRequestSummary>;
|
|
1881
|
+
/**
|
|
1882
|
+
* Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequests operation. This iterator
|
|
1883
|
+
* will fetch more data from the server as needed.
|
|
1884
|
+
*
|
|
1885
|
+
* @param request a request which can be sent to the service operation
|
|
1886
|
+
*/
|
|
1887
|
+
listTaggingWorkRequestsResponseIterator(request: requests.ListTaggingWorkRequestsRequest): AsyncIterableIterator<responses.ListTaggingWorkRequestsResponse>;
|
|
1521
1888
|
/**
|
|
1522
1889
|
* Lists the tag definitions in the specified tag namespace.
|
|
1523
1890
|
*
|
|
1891
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1524
1892
|
* @param ListTagsRequest
|
|
1525
1893
|
* @return ListTagsResponse
|
|
1526
1894
|
* @throws OciError when an error occurs
|
|
1527
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1895
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListTags.ts.html |here} to see how to use ListTags API.
|
|
1528
1896
|
*/
|
|
1529
1897
|
listTags(listTagsRequest: requests.ListTagsRequest): Promise<responses.ListTagsResponse>;
|
|
1530
1898
|
/**
|
|
1899
|
+
* NOTE: This function is deprecated in favor of listTagsRecordIterator function.
|
|
1531
1900
|
* Creates a new async iterator which will iterate over the models.TagSummary objects
|
|
1532
1901
|
* contained in responses from the listTags operation. This iterator will fetch more data from the
|
|
1533
1902
|
* server as needed.
|
|
@@ -1536,12 +1905,28 @@ export declare class IdentityClient {
|
|
|
1536
1905
|
*/
|
|
1537
1906
|
listAllTags(request: requests.ListTagsRequest): AsyncIterableIterator<model.TagSummary>;
|
|
1538
1907
|
/**
|
|
1908
|
+
* NOTE: This function is deprecated in favor of listTagsResponseIterator function.
|
|
1539
1909
|
* Creates a new async iterator which will iterate over the responses received from the listTags operation. This iterator
|
|
1540
1910
|
* will fetch more data from the server as needed.
|
|
1541
1911
|
*
|
|
1542
1912
|
* @param request a request which can be sent to the service operation
|
|
1543
1913
|
*/
|
|
1544
1914
|
listAllTagsResponses(request: requests.ListTagsRequest): AsyncIterableIterator<responses.ListTagsResponse>;
|
|
1915
|
+
/**
|
|
1916
|
+
* Creates a new async iterator which will iterate over the models.TagSummary objects
|
|
1917
|
+
* contained in responses from the listTags operation. This iterator will fetch more data from the
|
|
1918
|
+
* server as needed.
|
|
1919
|
+
*
|
|
1920
|
+
* @param request a request which can be sent to the service operation
|
|
1921
|
+
*/
|
|
1922
|
+
listTagsRecordIterator(request: requests.ListTagsRequest): AsyncIterableIterator<model.TagSummary>;
|
|
1923
|
+
/**
|
|
1924
|
+
* Creates a new async iterator which will iterate over the responses received from the listTags operation. This iterator
|
|
1925
|
+
* will fetch more data from the server as needed.
|
|
1926
|
+
*
|
|
1927
|
+
* @param request a request which can be sent to the service operation
|
|
1928
|
+
*/
|
|
1929
|
+
listTagsResponseIterator(request: requests.ListTagsRequest): AsyncIterableIterator<responses.ListTagsResponse>;
|
|
1545
1930
|
/**
|
|
1546
1931
|
* Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID
|
|
1547
1932
|
* as the value for the compartment ID
|
|
@@ -1554,13 +1939,15 @@ export declare class IdentityClient {
|
|
|
1554
1939
|
* If the answer is no, the response is an empty list.
|
|
1555
1940
|
* - Although`userId` and `groupId` are not individually required, you must set one of them.
|
|
1556
1941
|
*
|
|
1942
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1557
1943
|
* @param ListUserGroupMembershipsRequest
|
|
1558
1944
|
* @return ListUserGroupMembershipsResponse
|
|
1559
1945
|
* @throws OciError when an error occurs
|
|
1560
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1946
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListUserGroupMemberships.ts.html |here} to see how to use ListUserGroupMemberships API.
|
|
1561
1947
|
*/
|
|
1562
1948
|
listUserGroupMemberships(listUserGroupMembershipsRequest: requests.ListUserGroupMembershipsRequest): Promise<responses.ListUserGroupMembershipsResponse>;
|
|
1563
1949
|
/**
|
|
1950
|
+
* NOTE: This function is deprecated in favor of listUserGroupMembershipsRecordIterator function.
|
|
1564
1951
|
* Creates a new async iterator which will iterate over the models.UserGroupMembership objects
|
|
1565
1952
|
* contained in responses from the listUserGroupMemberships operation. This iterator will fetch more data from the
|
|
1566
1953
|
* server as needed.
|
|
@@ -1569,24 +1956,42 @@ export declare class IdentityClient {
|
|
|
1569
1956
|
*/
|
|
1570
1957
|
listAllUserGroupMemberships(request: requests.ListUserGroupMembershipsRequest): AsyncIterableIterator<model.UserGroupMembership>;
|
|
1571
1958
|
/**
|
|
1959
|
+
* NOTE: This function is deprecated in favor of listUserGroupMembershipsResponseIterator function.
|
|
1572
1960
|
* Creates a new async iterator which will iterate over the responses received from the listUserGroupMemberships operation. This iterator
|
|
1573
1961
|
* will fetch more data from the server as needed.
|
|
1574
1962
|
*
|
|
1575
1963
|
* @param request a request which can be sent to the service operation
|
|
1576
1964
|
*/
|
|
1577
1965
|
listAllUserGroupMembershipsResponses(request: requests.ListUserGroupMembershipsRequest): AsyncIterableIterator<responses.ListUserGroupMembershipsResponse>;
|
|
1966
|
+
/**
|
|
1967
|
+
* Creates a new async iterator which will iterate over the models.UserGroupMembership objects
|
|
1968
|
+
* contained in responses from the listUserGroupMemberships operation. This iterator will fetch more data from the
|
|
1969
|
+
* server as needed.
|
|
1970
|
+
*
|
|
1971
|
+
* @param request a request which can be sent to the service operation
|
|
1972
|
+
*/
|
|
1973
|
+
listUserGroupMembershipsRecordIterator(request: requests.ListUserGroupMembershipsRequest): AsyncIterableIterator<model.UserGroupMembership>;
|
|
1974
|
+
/**
|
|
1975
|
+
* Creates a new async iterator which will iterate over the responses received from the listUserGroupMemberships operation. This iterator
|
|
1976
|
+
* will fetch more data from the server as needed.
|
|
1977
|
+
*
|
|
1978
|
+
* @param request a request which can be sent to the service operation
|
|
1979
|
+
*/
|
|
1980
|
+
listUserGroupMembershipsResponseIterator(request: requests.ListUserGroupMembershipsRequest): AsyncIterableIterator<responses.ListUserGroupMembershipsResponse>;
|
|
1578
1981
|
/**
|
|
1579
1982
|
* Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the
|
|
1580
1983
|
* compartment ID (remember that the tenancy is simply the root compartment).
|
|
1581
1984
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1582
1985
|
*
|
|
1986
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1583
1987
|
* @param ListUsersRequest
|
|
1584
1988
|
* @return ListUsersResponse
|
|
1585
1989
|
* @throws OciError when an error occurs
|
|
1586
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1990
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListUsers.ts.html |here} to see how to use ListUsers API.
|
|
1587
1991
|
*/
|
|
1588
1992
|
listUsers(listUsersRequest: requests.ListUsersRequest): Promise<responses.ListUsersResponse>;
|
|
1589
1993
|
/**
|
|
1994
|
+
* NOTE: This function is deprecated in favor of listUsersRecordIterator function.
|
|
1590
1995
|
* Creates a new async iterator which will iterate over the models.User objects
|
|
1591
1996
|
* contained in responses from the listUsers operation. This iterator will fetch more data from the
|
|
1592
1997
|
* server as needed.
|
|
@@ -1595,22 +2000,40 @@ export declare class IdentityClient {
|
|
|
1595
2000
|
*/
|
|
1596
2001
|
listAllUsers(request: requests.ListUsersRequest): AsyncIterableIterator<model.User>;
|
|
1597
2002
|
/**
|
|
2003
|
+
* NOTE: This function is deprecated in favor of listUsersResponseIterator function.
|
|
1598
2004
|
* Creates a new async iterator which will iterate over the responses received from the listUsers operation. This iterator
|
|
1599
2005
|
* will fetch more data from the server as needed.
|
|
1600
2006
|
*
|
|
1601
2007
|
* @param request a request which can be sent to the service operation
|
|
1602
2008
|
*/
|
|
1603
2009
|
listAllUsersResponses(request: requests.ListUsersRequest): AsyncIterableIterator<responses.ListUsersResponse>;
|
|
2010
|
+
/**
|
|
2011
|
+
* Creates a new async iterator which will iterate over the models.User objects
|
|
2012
|
+
* contained in responses from the listUsers operation. This iterator will fetch more data from the
|
|
2013
|
+
* server as needed.
|
|
2014
|
+
*
|
|
2015
|
+
* @param request a request which can be sent to the service operation
|
|
2016
|
+
*/
|
|
2017
|
+
listUsersRecordIterator(request: requests.ListUsersRequest): AsyncIterableIterator<model.User>;
|
|
2018
|
+
/**
|
|
2019
|
+
* Creates a new async iterator which will iterate over the responses received from the listUsers operation. This iterator
|
|
2020
|
+
* will fetch more data from the server as needed.
|
|
2021
|
+
*
|
|
2022
|
+
* @param request a request which can be sent to the service operation
|
|
2023
|
+
*/
|
|
2024
|
+
listUsersResponseIterator(request: requests.ListUsersRequest): AsyncIterableIterator<responses.ListUsersResponse>;
|
|
1604
2025
|
/**
|
|
1605
2026
|
* Lists the work requests in compartment.
|
|
1606
2027
|
*
|
|
2028
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1607
2029
|
* @param ListWorkRequestsRequest
|
|
1608
2030
|
* @return ListWorkRequestsResponse
|
|
1609
2031
|
* @throws OciError when an error occurs
|
|
1610
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2032
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
1611
2033
|
*/
|
|
1612
2034
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
1613
2035
|
/**
|
|
2036
|
+
* NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function.
|
|
1614
2037
|
* Creates a new async iterator which will iterate over the models.WorkRequestSummary objects
|
|
1615
2038
|
* contained in responses from the listWorkRequests operation. This iterator will fetch more data from the
|
|
1616
2039
|
* server as needed.
|
|
@@ -1619,12 +2042,28 @@ export declare class IdentityClient {
|
|
|
1619
2042
|
*/
|
|
1620
2043
|
listAllWorkRequests(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<model.WorkRequestSummary>;
|
|
1621
2044
|
/**
|
|
2045
|
+
* NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function.
|
|
1622
2046
|
* Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator
|
|
1623
2047
|
* will fetch more data from the server as needed.
|
|
1624
2048
|
*
|
|
1625
2049
|
* @param request a request which can be sent to the service operation
|
|
1626
2050
|
*/
|
|
1627
2051
|
listAllWorkRequestsResponses(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
|
|
2052
|
+
/**
|
|
2053
|
+
* Creates a new async iterator which will iterate over the models.WorkRequestSummary objects
|
|
2054
|
+
* contained in responses from the listWorkRequests operation. This iterator will fetch more data from the
|
|
2055
|
+
* server as needed.
|
|
2056
|
+
*
|
|
2057
|
+
* @param request a request which can be sent to the service operation
|
|
2058
|
+
*/
|
|
2059
|
+
listWorkRequestsRecordIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<model.WorkRequestSummary>;
|
|
2060
|
+
/**
|
|
2061
|
+
* Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator
|
|
2062
|
+
* will fetch more data from the server as needed.
|
|
2063
|
+
*
|
|
2064
|
+
* @param request a request which can be sent to the service operation
|
|
2065
|
+
*/
|
|
2066
|
+
listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
|
|
1628
2067
|
/**
|
|
1629
2068
|
* Move the compartment to a different parent compartment in the same tenancy. When you move a
|
|
1630
2069
|
* compartment, all its contents (subcompartments and resources) are moved with it. Note that
|
|
@@ -1635,120 +2074,134 @@ export declare class IdentityClient {
|
|
|
1635
2074
|
* are aware of the implications for the compartment contents before you move it. For more
|
|
1636
2075
|
* information, see [Moving a Compartment](https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcompartments.htm#MoveCompartment).
|
|
1637
2076
|
*
|
|
2077
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1638
2078
|
* @param MoveCompartmentRequest
|
|
1639
2079
|
* @return MoveCompartmentResponse
|
|
1640
2080
|
* @throws OciError when an error occurs
|
|
1641
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2081
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/MoveCompartment.ts.html |here} to see how to use MoveCompartment API.
|
|
1642
2082
|
*/
|
|
1643
2083
|
moveCompartment(moveCompartmentRequest: requests.MoveCompartmentRequest): Promise<responses.MoveCompartmentResponse>;
|
|
1644
2084
|
/**
|
|
1645
2085
|
* Recover the compartment from DELETED state to ACTIVE state.
|
|
1646
2086
|
*
|
|
2087
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1647
2088
|
* @param RecoverCompartmentRequest
|
|
1648
2089
|
* @return RecoverCompartmentResponse
|
|
1649
2090
|
* @throws OciError when an error occurs
|
|
1650
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2091
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/RecoverCompartment.ts.html |here} to see how to use RecoverCompartment API.
|
|
1651
2092
|
*/
|
|
1652
2093
|
recoverCompartment(recoverCompartmentRequest: requests.RecoverCompartmentRequest): Promise<responses.RecoverCompartmentResponse>;
|
|
1653
2094
|
/**
|
|
1654
2095
|
* Removes a user from a group by deleting the corresponding `UserGroupMembership`.
|
|
2096
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1655
2097
|
* @param RemoveUserFromGroupRequest
|
|
1656
2098
|
* @return RemoveUserFromGroupResponse
|
|
1657
2099
|
* @throws OciError when an error occurs
|
|
1658
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2100
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/RemoveUserFromGroup.ts.html |here} to see how to use RemoveUserFromGroup API.
|
|
1659
2101
|
*/
|
|
1660
2102
|
removeUserFromGroup(removeUserFromGroupRequest: requests.RemoveUserFromGroupRequest): Promise<responses.RemoveUserFromGroupResponse>;
|
|
1661
2103
|
/**
|
|
1662
2104
|
* Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
|
|
1663
2105
|
*
|
|
2106
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1664
2107
|
* @param ResetIdpScimClientRequest
|
|
1665
2108
|
* @return ResetIdpScimClientResponse
|
|
1666
2109
|
* @throws OciError when an error occurs
|
|
1667
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2110
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/ResetIdpScimClient.ts.html |here} to see how to use ResetIdpScimClient API.
|
|
1668
2111
|
*/
|
|
1669
2112
|
resetIdpScimClient(resetIdpScimClientRequest: requests.ResetIdpScimClientRequest): Promise<responses.ResetIdpScimClientResponse>;
|
|
1670
2113
|
/**
|
|
1671
2114
|
* Updates the specified auth token's description.
|
|
1672
2115
|
*
|
|
2116
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1673
2117
|
* @param UpdateAuthTokenRequest
|
|
1674
2118
|
* @return UpdateAuthTokenResponse
|
|
1675
2119
|
* @throws OciError when an error occurs
|
|
1676
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2120
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateAuthToken.ts.html |here} to see how to use UpdateAuthToken API.
|
|
1677
2121
|
*/
|
|
1678
2122
|
updateAuthToken(updateAuthTokenRequest: requests.UpdateAuthTokenRequest): Promise<responses.UpdateAuthTokenResponse>;
|
|
1679
2123
|
/**
|
|
1680
2124
|
* Updates authentication policy for the specified tenancy
|
|
1681
2125
|
*
|
|
2126
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1682
2127
|
* @param UpdateAuthenticationPolicyRequest
|
|
1683
2128
|
* @return UpdateAuthenticationPolicyResponse
|
|
1684
2129
|
* @throws OciError when an error occurs
|
|
1685
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2130
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateAuthenticationPolicy.ts.html |here} to see how to use UpdateAuthenticationPolicy API.
|
|
1686
2131
|
*/
|
|
1687
2132
|
updateAuthenticationPolicy(updateAuthenticationPolicyRequest: requests.UpdateAuthenticationPolicyRequest): Promise<responses.UpdateAuthenticationPolicyResponse>;
|
|
1688
2133
|
/**
|
|
1689
2134
|
* Updates the specified compartment's description or name. You can't update the root compartment.
|
|
2135
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1690
2136
|
* @param UpdateCompartmentRequest
|
|
1691
2137
|
* @return UpdateCompartmentResponse
|
|
1692
2138
|
* @throws OciError when an error occurs
|
|
1693
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2139
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateCompartment.ts.html |here} to see how to use UpdateCompartment API.
|
|
1694
2140
|
*/
|
|
1695
2141
|
updateCompartment(updateCompartmentRequest: requests.UpdateCompartmentRequest): Promise<responses.UpdateCompartmentResponse>;
|
|
1696
2142
|
/**
|
|
1697
2143
|
* Updates the specified secret key's description.
|
|
1698
2144
|
*
|
|
2145
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1699
2146
|
* @param UpdateCustomerSecretKeyRequest
|
|
1700
2147
|
* @return UpdateCustomerSecretKeyResponse
|
|
1701
2148
|
* @throws OciError when an error occurs
|
|
1702
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2149
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateCustomerSecretKey.ts.html |here} to see how to use UpdateCustomerSecretKey API.
|
|
1703
2150
|
*/
|
|
1704
2151
|
updateCustomerSecretKey(updateCustomerSecretKeyRequest: requests.UpdateCustomerSecretKeyRequest): Promise<responses.UpdateCustomerSecretKeyResponse>;
|
|
1705
2152
|
/**
|
|
1706
2153
|
* Updates the specified dynamic group.
|
|
2154
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1707
2155
|
* @param UpdateDynamicGroupRequest
|
|
1708
2156
|
* @return UpdateDynamicGroupResponse
|
|
1709
2157
|
* @throws OciError when an error occurs
|
|
1710
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2158
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateDynamicGroup.ts.html |here} to see how to use UpdateDynamicGroup API.
|
|
1711
2159
|
*/
|
|
1712
2160
|
updateDynamicGroup(updateDynamicGroupRequest: requests.UpdateDynamicGroupRequest): Promise<responses.UpdateDynamicGroupResponse>;
|
|
1713
2161
|
/**
|
|
1714
2162
|
* Updates the specified group.
|
|
2163
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1715
2164
|
* @param UpdateGroupRequest
|
|
1716
2165
|
* @return UpdateGroupResponse
|
|
1717
2166
|
* @throws OciError when an error occurs
|
|
1718
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2167
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateGroup.ts.html |here} to see how to use UpdateGroup API.
|
|
1719
2168
|
*/
|
|
1720
2169
|
updateGroup(updateGroupRequest: requests.UpdateGroupRequest): Promise<responses.UpdateGroupResponse>;
|
|
1721
2170
|
/**
|
|
1722
2171
|
* Updates the specified identity provider.
|
|
2172
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1723
2173
|
* @param UpdateIdentityProviderRequest
|
|
1724
2174
|
* @return UpdateIdentityProviderResponse
|
|
1725
2175
|
* @throws OciError when an error occurs
|
|
1726
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2176
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateIdentityProvider.ts.html |here} to see how to use UpdateIdentityProvider API.
|
|
1727
2177
|
*/
|
|
1728
2178
|
updateIdentityProvider(updateIdentityProviderRequest: requests.UpdateIdentityProviderRequest): Promise<responses.UpdateIdentityProviderResponse>;
|
|
1729
2179
|
/**
|
|
1730
2180
|
* Updates the specified group mapping.
|
|
2181
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1731
2182
|
* @param UpdateIdpGroupMappingRequest
|
|
1732
2183
|
* @return UpdateIdpGroupMappingResponse
|
|
1733
2184
|
* @throws OciError when an error occurs
|
|
1734
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2185
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateIdpGroupMapping.ts.html |here} to see how to use UpdateIdpGroupMapping API.
|
|
1735
2186
|
*/
|
|
1736
2187
|
updateIdpGroupMapping(updateIdpGroupMappingRequest: requests.UpdateIdpGroupMappingRequest): Promise<responses.UpdateIdpGroupMappingResponse>;
|
|
1737
2188
|
/**
|
|
1738
2189
|
* Updates the specified network source.
|
|
2190
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1739
2191
|
* @param UpdateNetworkSourceRequest
|
|
1740
2192
|
* @return UpdateNetworkSourceResponse
|
|
1741
2193
|
* @throws OciError when an error occurs
|
|
1742
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2194
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateNetworkSource.ts.html |here} to see how to use UpdateNetworkSource API.
|
|
1743
2195
|
*/
|
|
1744
2196
|
updateNetworkSource(updateNetworkSourceRequest: requests.UpdateNetworkSourceRequest): Promise<responses.UpdateNetworkSourceResponse>;
|
|
1745
2197
|
/**
|
|
1746
2198
|
* Updates Oauth token for the user
|
|
1747
2199
|
*
|
|
2200
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1748
2201
|
* @param UpdateOAuthClientCredentialRequest
|
|
1749
2202
|
* @return UpdateOAuthClientCredentialResponse
|
|
1750
2203
|
* @throws OciError when an error occurs
|
|
1751
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2204
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateOAuthClientCredential.ts.html |here} to see how to use UpdateOAuthClientCredential API.
|
|
1752
2205
|
*/
|
|
1753
2206
|
updateOAuthClientCredential(updateOAuthClientCredentialRequest: requests.UpdateOAuthClientCredentialRequest): Promise<responses.UpdateOAuthClientCredentialResponse>;
|
|
1754
2207
|
/**
|
|
@@ -1756,19 +2209,21 @@ export declare class IdentityClient {
|
|
|
1756
2209
|
* <p>
|
|
1757
2210
|
Policy changes take effect typically within 10 seconds.
|
|
1758
2211
|
*
|
|
2212
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1759
2213
|
* @param UpdatePolicyRequest
|
|
1760
2214
|
* @return UpdatePolicyResponse
|
|
1761
2215
|
* @throws OciError when an error occurs
|
|
1762
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2216
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdatePolicy.ts.html |here} to see how to use UpdatePolicy API.
|
|
1763
2217
|
*/
|
|
1764
2218
|
updatePolicy(updatePolicyRequest: requests.UpdatePolicyRequest): Promise<responses.UpdatePolicyResponse>;
|
|
1765
2219
|
/**
|
|
1766
2220
|
* Updates the specified SMTP credential's description.
|
|
1767
2221
|
*
|
|
2222
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1768
2223
|
* @param UpdateSmtpCredentialRequest
|
|
1769
2224
|
* @return UpdateSmtpCredentialResponse
|
|
1770
2225
|
* @throws OciError when an error occurs
|
|
1771
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2226
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateSmtpCredential.ts.html |here} to see how to use UpdateSmtpCredential API.
|
|
1772
2227
|
*/
|
|
1773
2228
|
updateSmtpCredential(updateSmtpCredentialRequest: requests.UpdateSmtpCredentialRequest): Promise<responses.UpdateSmtpCredentialResponse>;
|
|
1774
2229
|
/**
|
|
@@ -1776,10 +2231,11 @@ export declare class IdentityClient {
|
|
|
1776
2231
|
* <p>
|
|
1777
2232
|
Updates the specified Swift password's description.
|
|
1778
2233
|
*
|
|
2234
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1779
2235
|
* @param UpdateSwiftPasswordRequest
|
|
1780
2236
|
* @return UpdateSwiftPasswordResponse
|
|
1781
2237
|
* @throws OciError when an error occurs
|
|
1782
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2238
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateSwiftPassword.ts.html |here} to see how to use UpdateSwiftPassword API.
|
|
1783
2239
|
*/
|
|
1784
2240
|
updateSwiftPassword(updateSwiftPasswordRequest: requests.UpdateSwiftPasswordRequest): Promise<responses.UpdateSwiftPasswordResponse>;
|
|
1785
2241
|
/**
|
|
@@ -1794,10 +2250,11 @@ export declare class IdentityClient {
|
|
|
1794
2250
|
You cannot remove list values that appear in a TagDefault. To remove a list value that
|
|
1795
2251
|
* appears in a TagDefault, first update the TagDefault to use a different value.
|
|
1796
2252
|
*
|
|
2253
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1797
2254
|
* @param UpdateTagRequest
|
|
1798
2255
|
* @return UpdateTagResponse
|
|
1799
2256
|
* @throws OciError when an error occurs
|
|
1800
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2257
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateTag.ts.html |here} to see how to use UpdateTag API.
|
|
1801
2258
|
*/
|
|
1802
2259
|
updateTag(updateTagRequest: requests.UpdateTagRequest): Promise<responses.UpdateTagResponse>;
|
|
1803
2260
|
/**
|
|
@@ -1808,10 +2265,11 @@ export declare class IdentityClient {
|
|
|
1808
2265
|
* If the `isRequired` flag is set to \"true\", the value is set during resource creation.
|
|
1809
2266
|
* * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
|
|
1810
2267
|
*
|
|
2268
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1811
2269
|
* @param UpdateTagDefaultRequest
|
|
1812
2270
|
* @return UpdateTagDefaultResponse
|
|
1813
2271
|
* @throws OciError when an error occurs
|
|
1814
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2272
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateTagDefault.ts.html |here} to see how to use UpdateTagDefault API.
|
|
1815
2273
|
*/
|
|
1816
2274
|
updateTagDefault(updateTagDefaultRequest: requests.UpdateTagDefaultRequest): Promise<responses.UpdateTagDefaultResponse>;
|
|
1817
2275
|
/**
|
|
@@ -1825,36 +2283,40 @@ export declare class IdentityClient {
|
|
|
1825
2283
|
* <p>
|
|
1826
2284
|
You can't add a namespace with the same name as a retired namespace in the same tenancy.
|
|
1827
2285
|
*
|
|
2286
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1828
2287
|
* @param UpdateTagNamespaceRequest
|
|
1829
2288
|
* @return UpdateTagNamespaceResponse
|
|
1830
2289
|
* @throws OciError when an error occurs
|
|
1831
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2290
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateTagNamespace.ts.html |here} to see how to use UpdateTagNamespace API.
|
|
1832
2291
|
*/
|
|
1833
2292
|
updateTagNamespace(updateTagNamespaceRequest: requests.UpdateTagNamespaceRequest): Promise<responses.UpdateTagNamespaceResponse>;
|
|
1834
2293
|
/**
|
|
1835
2294
|
* Updates the description of the specified user.
|
|
2295
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1836
2296
|
* @param UpdateUserRequest
|
|
1837
2297
|
* @return UpdateUserResponse
|
|
1838
2298
|
* @throws OciError when an error occurs
|
|
1839
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2299
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateUser.ts.html |here} to see how to use UpdateUser API.
|
|
1840
2300
|
*/
|
|
1841
2301
|
updateUser(updateUserRequest: requests.UpdateUserRequest): Promise<responses.UpdateUserResponse>;
|
|
1842
2302
|
/**
|
|
1843
2303
|
* Updates the capabilities of the specified user.
|
|
1844
2304
|
*
|
|
2305
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1845
2306
|
* @param UpdateUserCapabilitiesRequest
|
|
1846
2307
|
* @return UpdateUserCapabilitiesResponse
|
|
1847
2308
|
* @throws OciError when an error occurs
|
|
1848
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2309
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateUserCapabilities.ts.html |here} to see how to use UpdateUserCapabilities API.
|
|
1849
2310
|
*/
|
|
1850
2311
|
updateUserCapabilities(updateUserCapabilitiesRequest: requests.UpdateUserCapabilitiesRequest): Promise<responses.UpdateUserCapabilitiesResponse>;
|
|
1851
2312
|
/**
|
|
1852
2313
|
* Updates the state of the specified user.
|
|
1853
2314
|
*
|
|
2315
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1854
2316
|
* @param UpdateUserStateRequest
|
|
1855
2317
|
* @return UpdateUserStateResponse
|
|
1856
2318
|
* @throws OciError when an error occurs
|
|
1857
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2319
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UpdateUserState.ts.html |here} to see how to use UpdateUserState API.
|
|
1858
2320
|
*/
|
|
1859
2321
|
updateUserState(updateUserStateRequest: requests.UpdateUserStateRequest): Promise<responses.UpdateUserStateResponse>;
|
|
1860
2322
|
/**
|
|
@@ -1874,10 +2336,11 @@ export declare class IdentityClient {
|
|
|
1874
2336
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using
|
|
1875
2337
|
* the object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
1876
2338
|
*
|
|
2339
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1877
2340
|
* @param UploadApiKeyRequest
|
|
1878
2341
|
* @return UploadApiKeyResponse
|
|
1879
2342
|
* @throws OciError when an error occurs
|
|
1880
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2343
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/identity/UploadApiKey.ts.html |here} to see how to use UploadApiKey API.
|
|
1881
2344
|
*/
|
|
1882
2345
|
uploadApiKey(uploadApiKeyRequest: requests.UploadApiKeyRequest): Promise<responses.UploadApiKeyResponse>;
|
|
1883
2346
|
}
|