oci-identity 2.5.0 → 2.6.1
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 +747 -181
- package/lib/client.js +1937 -425
- package/lib/client.js.map +1 -1
- package/lib/identity-waiter.d.ts +15 -0
- package/lib/identity-waiter.js +23 -0
- package/lib/identity-waiter.js.map +1 -1
- package/lib/model/allowed-domain-license-type-summary.d.ts +40 -0
- package/lib/model/allowed-domain-license-type-summary.js +29 -0
- package/lib/model/allowed-domain-license-type-summary.js.map +1 -0
- package/lib/model/change-domain-compartment-details.d.ts +24 -0
- package/lib/model/change-domain-compartment-details.js +29 -0
- package/lib/model/change-domain-compartment-details.js.map +1 -0
- package/lib/model/change-domain-license-type-details.d.ts +25 -0
- package/lib/model/change-domain-license-type-details.js +29 -0
- package/lib/model/change-domain-license-type-details.js.map +1 -0
- package/lib/model/change-tas-domain-license-type-details.d.ts +25 -0
- package/lib/model/change-tas-domain-license-type-details.js +29 -0
- package/lib/model/change-tas-domain-license-type-details.js.map +1 -0
- package/lib/model/create-domain-details.d.ts +99 -0
- package/lib/model/create-domain-details.js +29 -0
- package/lib/model/create-domain-details.js.map +1 -0
- package/lib/model/domain-replication-states.d.ts +41 -0
- package/lib/model/domain-replication-states.js +37 -0
- package/lib/model/domain-replication-states.js.map +1 -0
- package/lib/model/domain-replication.d.ts +34 -0
- package/lib/model/domain-replication.js +61 -0
- package/lib/model/domain-replication.js.map +1 -0
- package/lib/model/domain-summary.d.ts +136 -0
- package/lib/model/domain-summary.js +94 -0
- package/lib/model/domain-summary.js.map +1 -0
- package/lib/model/domain.d.ts +140 -0
- package/lib/model/domain.js +94 -0
- package/lib/model/domain.js.map +1 -0
- package/lib/model/enable-replication-to-region-details.d.ts +30 -0
- package/lib/model/enable-replication-to-region-details.js +29 -0
- package/lib/model/enable-replication-to-region-details.js.map +1 -0
- package/lib/model/iam-work-request-error-summary.d.ts +33 -0
- package/lib/model/iam-work-request-error-summary.js +29 -0
- package/lib/model/iam-work-request-error-summary.js.map +1 -0
- package/lib/model/iam-work-request-log-summary.d.ts +32 -0
- package/lib/model/iam-work-request-log-summary.js +29 -0
- package/lib/model/iam-work-request-log-summary.js.map +1 -0
- package/lib/model/iam-work-request-resource.d.ts +53 -0
- package/lib/model/iam-work-request-resource.js +42 -0
- package/lib/model/iam-work-request-resource.js.map +1 -0
- package/lib/model/iam-work-request-summary.d.ts +94 -0
- package/lib/model/iam-work-request-summary.js +91 -0
- package/lib/model/iam-work-request-summary.js.map +1 -0
- package/lib/model/iam-work-request.d.ts +93 -0
- package/lib/model/iam-work-request.js +91 -0
- package/lib/model/iam-work-request.js.map +1 -0
- package/lib/model/index.d.ts +34 -0
- package/lib/model/index.js +37 -3
- package/lib/model/index.js.map +1 -1
- package/lib/model/replicated-region-details.d.ts +49 -0
- package/lib/model/replicated-region-details.js +42 -0
- package/lib/model/replicated-region-details.js.map +1 -0
- package/lib/model/update-domain-details.d.ts +54 -0
- package/lib/model/update-domain-details.js +29 -0
- package/lib/model/update-domain-details.js.map +1 -0
- package/lib/request/activate-domain-request.d.ts +44 -0
- package/lib/request/activate-domain-request.js +15 -0
- package/lib/request/activate-domain-request.js.map +1 -0
- 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-domain-compartment-request.d.ts +49 -0
- package/lib/request/change-domain-compartment-request.js +15 -0
- package/lib/request/change-domain-compartment-request.js.map +1 -0
- package/lib/request/change-domain-license-type-request.d.ts +49 -0
- package/lib/request/change-domain-license-type-request.js +15 -0
- package/lib/request/change-domain-license-type-request.js.map +1 -0
- 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-domain-request.d.ts +38 -0
- package/lib/request/create-domain-request.js +15 -0
- package/lib/request/create-domain-request.js.map +1 -0
- 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/deactivate-domain-request.d.ts +44 -0
- package/lib/request/deactivate-domain-request.js +15 -0
- package/lib/request/deactivate-domain-request.js.map +1 -0
- 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-domain-request.d.ts +35 -0
- package/lib/request/delete-domain-request.js +15 -0
- package/lib/request/delete-domain-request.js.map +1 -0
- 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/enable-replication-to-region-request.d.ts +49 -0
- package/lib/request/enable-replication-to-region-request.js +15 -0
- package/lib/request/enable-replication-to-region-request.js.map +1 -0
- 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-domain-request.d.ts +28 -0
- package/lib/request/get-domain-request.js +15 -0
- package/lib/request/get-domain-request.js.map +1 -0
- 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-iam-work-request-request.d.ts +28 -0
- package/lib/request/get-iam-work-request-request.js +15 -0
- package/lib/request/get-iam-work-request-request.js.map +1 -0
- 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/index.d.ts +30 -0
- package/lib/request/index.js +7 -1
- package/lib/request/index.js.map +1 -1
- package/lib/request/list-allowed-domain-license-types-request.d.ts +28 -0
- package/lib/request/list-allowed-domain-license-types-request.js +15 -0
- package/lib/request/list-allowed-domain-license-types-request.js.map +1 -0
- 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-domains-request.d.ts +101 -0
- package/lib/request/list-domains-request.js +29 -0
- package/lib/request/list-domains-request.js.map +1 -0
- 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-iam-work-request-errors-request.d.ts +50 -0
- package/lib/request/list-iam-work-request-errors-request.js +24 -0
- package/lib/request/list-iam-work-request-errors-request.js.map +1 -0
- package/lib/request/list-iam-work-request-logs-request.d.ts +50 -0
- package/lib/request/list-iam-work-request-logs-request.js +24 -0
- package/lib/request/list-iam-work-request-logs-request.js.map +1 -0
- package/lib/request/list-iam-work-requests-request.d.ts +43 -0
- package/lib/request/list-iam-work-requests-request.js +15 -0
- package/lib/request/list-iam-work-requests-request.js.map +1 -0
- 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-domain-request.d.ts +40 -0
- package/lib/request/update-domain-request.js +15 -0
- package/lib/request/update-domain-request.js.map +1 -0
- 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/lib/response/activate-domain-response.d.ts +25 -0
- package/lib/response/activate-domain-response.js +15 -0
- package/lib/response/activate-domain-response.js.map +1 -0
- package/lib/response/change-domain-compartment-response.d.ts +25 -0
- package/lib/response/change-domain-compartment-response.js +15 -0
- package/lib/response/change-domain-compartment-response.js.map +1 -0
- package/lib/response/change-domain-license-type-response.d.ts +25 -0
- package/lib/response/change-domain-license-type-response.js +15 -0
- package/lib/response/change-domain-license-type-response.js.map +1 -0
- package/lib/response/create-domain-response.d.ts +25 -0
- package/lib/response/create-domain-response.js +15 -0
- package/lib/response/create-domain-response.js.map +1 -0
- package/lib/response/deactivate-domain-response.d.ts +25 -0
- package/lib/response/deactivate-domain-response.js +15 -0
- package/lib/response/deactivate-domain-response.js.map +1 -0
- package/lib/response/delete-domain-response.d.ts +25 -0
- package/lib/response/delete-domain-response.js +15 -0
- package/lib/response/delete-domain-response.js.map +1 -0
- package/lib/response/enable-replication-to-region-response.d.ts +25 -0
- package/lib/response/enable-replication-to-region-response.js +15 -0
- package/lib/response/enable-replication-to-region-response.js.map +1 -0
- package/lib/response/get-domain-response.d.ts +29 -0
- package/lib/response/get-domain-response.js +15 -0
- package/lib/response/get-domain-response.js.map +1 -0
- package/lib/response/get-iam-work-request-response.d.ts +25 -0
- package/lib/response/get-iam-work-request-response.js +15 -0
- package/lib/response/get-iam-work-request-response.js.map +1 -0
- package/lib/response/index.d.ts +30 -0
- package/lib/response/list-allowed-domain-license-types-response.d.ts +32 -0
- package/lib/response/list-allowed-domain-license-types-response.js +15 -0
- package/lib/response/list-allowed-domain-license-types-response.js.map +1 -0
- package/lib/response/list-domains-response.d.ts +32 -0
- package/lib/response/list-domains-response.js +15 -0
- package/lib/response/list-domains-response.js.map +1 -0
- package/lib/response/list-iam-work-request-errors-response.d.ts +32 -0
- package/lib/response/list-iam-work-request-errors-response.js +15 -0
- package/lib/response/list-iam-work-request-errors-response.js.map +1 -0
- package/lib/response/list-iam-work-request-logs-response.d.ts +37 -0
- package/lib/response/list-iam-work-request-logs-response.js +15 -0
- package/lib/response/list-iam-work-request-logs-response.js.map +1 -0
- package/lib/response/list-iam-work-requests-response.d.ts +32 -0
- package/lib/response/list-iam-work-requests-response.js +15 -0
- package/lib/response/list-iam-work-requests-response.js.map +1 -0
- package/lib/response/update-domain-response.d.ts +25 -0
- package/lib/response/update-domain-response.js +15 -0
- package/lib/response/update-domain-response.js.map +1 -0
- 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;
|
|
@@ -64,13 +67,40 @@ export declare class IdentityClient {
|
|
|
64
67
|
* @return The service waiters.
|
|
65
68
|
*/
|
|
66
69
|
getWaiters(): IdentityWaiter;
|
|
70
|
+
/**
|
|
71
|
+
* If the domain's {@code lifecycleState} is INACTIVE,
|
|
72
|
+
* 1. Set the {@code lifecycleDetails} to ACTIVATING and asynchronously starts enabling
|
|
73
|
+
* the domain and return 202 ACCEPTED.
|
|
74
|
+
* 1.1 Sets the domain status to ENABLED and set specified domain's
|
|
75
|
+
* {@code lifecycleState} to ACTIVE and set the {@code lifecycleDetails} to null.
|
|
76
|
+
* <p>
|
|
77
|
+
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
78
|
+
* the async operation's status. Deactivate a domain can be done using HTTP POST
|
|
79
|
+
* /domains/{domainId}/actions/deactivate.
|
|
80
|
+
* <p>
|
|
81
|
+
- If the domain's {@code lifecycleState} is ACTIVE, returns 202 ACCEPTED with no action
|
|
82
|
+
* taken on service side.
|
|
83
|
+
* - If domain is of {@code type} DEFAULT or DEFAULT_LIGHTWEIGHT or domain's {@code lifecycleState} is not INACTIVE,
|
|
84
|
+
* returns 400 BAD REQUEST.
|
|
85
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
86
|
+
* - If the authenticated user is part of the domain to be activated, returns 400 BAD REQUEST
|
|
87
|
+
* - If error occurs while activating domain, returns 500 INTERNAL SERVER ERROR.
|
|
88
|
+
*
|
|
89
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
90
|
+
* @param ActivateDomainRequest
|
|
91
|
+
* @return ActivateDomainResponse
|
|
92
|
+
* @throws OciError when an error occurs
|
|
93
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ActivateDomain.ts.html |here} to see how to use ActivateDomain API.
|
|
94
|
+
*/
|
|
95
|
+
activateDomain(activateDomainRequest: requests.ActivateDomainRequest): Promise<responses.ActivateDomainResponse>;
|
|
67
96
|
/**
|
|
68
97
|
* Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.
|
|
69
98
|
*
|
|
99
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
70
100
|
* @param ActivateMfaTotpDeviceRequest
|
|
71
101
|
* @return ActivateMfaTotpDeviceResponse
|
|
72
102
|
* @throws OciError when an error occurs
|
|
73
|
-
* @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.1/identity/ActivateMfaTotpDevice.ts.html |here} to see how to use ActivateMfaTotpDevice API.
|
|
74
104
|
*/
|
|
75
105
|
activateMfaTotpDevice(activateMfaTotpDeviceRequest: requests.ActivateMfaTotpDeviceRequest): Promise<responses.ActivateMfaTotpDeviceResponse>;
|
|
76
106
|
/**
|
|
@@ -79,10 +109,11 @@ export declare class IdentityClient {
|
|
|
79
109
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
80
110
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
81
111
|
*
|
|
112
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
82
113
|
* @param AddUserToGroupRequest
|
|
83
114
|
* @return AddUserToGroupResponse
|
|
84
115
|
* @throws OciError when an error occurs
|
|
85
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
116
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/AddUserToGroup.ts.html |here} to see how to use AddUserToGroup API.
|
|
86
117
|
*/
|
|
87
118
|
addUserToGroup(addUserToGroupRequest: requests.AddUserToGroupRequest): Promise<responses.AddUserToGroupResponse>;
|
|
88
119
|
/**
|
|
@@ -91,10 +122,11 @@ export declare class IdentityClient {
|
|
|
91
122
|
* referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults
|
|
92
123
|
* includes all tag defaults from the current compartment back to the root compartment.
|
|
93
124
|
*
|
|
125
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
94
126
|
* @param AssembleEffectiveTagSetRequest
|
|
95
127
|
* @return AssembleEffectiveTagSetResponse
|
|
96
128
|
* @throws OciError when an error occurs
|
|
97
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
129
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/AssembleEffectiveTagSet.ts.html |here} to see how to use AssembleEffectiveTagSet API.
|
|
98
130
|
*/
|
|
99
131
|
assembleEffectiveTagSet(assembleEffectiveTagSetRequest: requests.AssembleEffectiveTagSetRequest): Promise<responses.AssembleEffectiveTagSetResponse>;
|
|
100
132
|
/**
|
|
@@ -104,10 +136,11 @@ export declare class IdentityClient {
|
|
|
104
136
|
* {@link WorkRequest}. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest}
|
|
105
137
|
* API to monitor the status of the bulk action.
|
|
106
138
|
*
|
|
139
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
107
140
|
* @param BulkDeleteResourcesRequest
|
|
108
141
|
* @return BulkDeleteResourcesResponse
|
|
109
142
|
* @throws OciError when an error occurs
|
|
110
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
143
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/BulkDeleteResources.ts.html |here} to see how to use BulkDeleteResources API.
|
|
111
144
|
*/
|
|
112
145
|
bulkDeleteResources(bulkDeleteResourcesRequest: requests.BulkDeleteResourcesRequest): Promise<responses.BulkDeleteResourcesResponse>;
|
|
113
146
|
/**
|
|
@@ -133,10 +166,11 @@ export declare class IdentityClient {
|
|
|
133
166
|
In order to delete tags, you must first retire the tags. Use {@link #updateTag(UpdateTagRequest) updateTag}
|
|
134
167
|
* to retire a tag.
|
|
135
168
|
*
|
|
169
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
136
170
|
* @param BulkDeleteTagsRequest
|
|
137
171
|
* @return BulkDeleteTagsResponse
|
|
138
172
|
* @throws OciError when an error occurs
|
|
139
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
173
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/BulkDeleteTags.ts.html |here} to see how to use BulkDeleteTags API.
|
|
140
174
|
*/
|
|
141
175
|
bulkDeleteTags(bulkDeleteTagsRequest: requests.BulkDeleteTagsRequest): Promise<responses.BulkDeleteTagsResponse>;
|
|
142
176
|
/**
|
|
@@ -155,10 +189,11 @@ export declare class IdentityClient {
|
|
|
155
189
|
* For example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`,
|
|
156
190
|
* `tag set-1` and `tag set-2` cannot have any common tag definitions.
|
|
157
191
|
*
|
|
192
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
158
193
|
* @param BulkEditTagsRequest
|
|
159
194
|
* @return BulkEditTagsResponse
|
|
160
195
|
* @throws OciError when an error occurs
|
|
161
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
196
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/BulkEditTags.ts.html |here} to see how to use BulkEditTags API.
|
|
162
197
|
*/
|
|
163
198
|
bulkEditTags(bulkEditTagsRequest: requests.BulkEditTagsRequest): Promise<responses.BulkEditTagsResponse>;
|
|
164
199
|
/**
|
|
@@ -168,10 +203,11 @@ export declare class IdentityClient {
|
|
|
168
203
|
* compartments. This operation creates a {@link WorkRequest}.
|
|
169
204
|
* Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.
|
|
170
205
|
*
|
|
206
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
171
207
|
* @param BulkMoveResourcesRequest
|
|
172
208
|
* @return BulkMoveResourcesResponse
|
|
173
209
|
* @throws OciError when an error occurs
|
|
174
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
210
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/BulkMoveResources.ts.html |here} to see how to use BulkMoveResources API.
|
|
175
211
|
*/
|
|
176
212
|
bulkMoveResources(bulkMoveResourcesRequest: requests.BulkMoveResourcesRequest): Promise<responses.BulkMoveResourcesResponse>;
|
|
177
213
|
/**
|
|
@@ -195,12 +231,58 @@ export declare class IdentityClient {
|
|
|
195
231
|
To delete a tag namespace, you must first retire it. Use {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}
|
|
196
232
|
* to retire a tag namespace.
|
|
197
233
|
*
|
|
234
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
198
235
|
* @param CascadeDeleteTagNamespaceRequest
|
|
199
236
|
* @return CascadeDeleteTagNamespaceResponse
|
|
200
237
|
* @throws OciError when an error occurs
|
|
201
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
238
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CascadeDeleteTagNamespace.ts.html |here} to see how to use CascadeDeleteTagNamespace API.
|
|
202
239
|
*/
|
|
203
240
|
cascadeDeleteTagNamespace(cascadeDeleteTagNamespaceRequest: requests.CascadeDeleteTagNamespaceRequest): Promise<responses.CascadeDeleteTagNamespaceResponse>;
|
|
241
|
+
/**
|
|
242
|
+
* Change the containing compartment for a domain.
|
|
243
|
+
* <p>
|
|
244
|
+
This is an asynchronous call where the Domain's compartment is changed and is updated with the new compartment information.
|
|
245
|
+
* To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
246
|
+
* the async operation's status.
|
|
247
|
+
* <p>
|
|
248
|
+
The compartment change is complete when accessed via domain URL and
|
|
249
|
+
* also returns new compartment OCID.
|
|
250
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
251
|
+
* - If Domain {@code type} is DEFAULT or DEFAULT_LIGHTWEIGHT, return 400 BAD Request
|
|
252
|
+
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
253
|
+
* - If error occurs while changing compartment for domain, return 500 INTERNAL SERVER ERROR.
|
|
254
|
+
*
|
|
255
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
256
|
+
* @param ChangeDomainCompartmentRequest
|
|
257
|
+
* @return ChangeDomainCompartmentResponse
|
|
258
|
+
* @throws OciError when an error occurs
|
|
259
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ChangeDomainCompartment.ts.html |here} to see how to use ChangeDomainCompartment API.
|
|
260
|
+
*/
|
|
261
|
+
changeDomainCompartment(changeDomainCompartmentRequest: requests.ChangeDomainCompartmentRequest): Promise<responses.ChangeDomainCompartmentResponse>;
|
|
262
|
+
/**
|
|
263
|
+
* If the domain's {@code lifecycleState} is ACTIVE, validates the requested {@code licenseType} update
|
|
264
|
+
* is allowed and
|
|
265
|
+
* 1. Set the {@code lifecycleDetails} to UPDATING
|
|
266
|
+
* 2. Asynchronously starts updating the domain and return 202 ACCEPTED.
|
|
267
|
+
* 2.1 Successfully updates specified domain's {@code licenseType}.
|
|
268
|
+
* 3. On completion set the {@code lifecycleDetails} to null.
|
|
269
|
+
* To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
270
|
+
* the async operation's status.
|
|
271
|
+
* <p>
|
|
272
|
+
- If license type update is successful, return 202 ACCEPTED
|
|
273
|
+
* - If requested {@code licenseType} validation fails, returns 400 Bad request.
|
|
274
|
+
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
275
|
+
* - If Domain {@code type} is DEFAULT or DEFAULT_LIGHTWEIGHT, return 400 BAD Request
|
|
276
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND
|
|
277
|
+
* - If any internal error occurs, returns 500 INTERNAL SERVER ERROR.
|
|
278
|
+
*
|
|
279
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
280
|
+
* @param ChangeDomainLicenseTypeRequest
|
|
281
|
+
* @return ChangeDomainLicenseTypeResponse
|
|
282
|
+
* @throws OciError when an error occurs
|
|
283
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ChangeDomainLicenseType.ts.html |here} to see how to use ChangeDomainLicenseType API.
|
|
284
|
+
*/
|
|
285
|
+
changeDomainLicenseType(changeDomainLicenseTypeRequest: requests.ChangeDomainLicenseTypeRequest): Promise<responses.ChangeDomainLicenseTypeResponse>;
|
|
204
286
|
/**
|
|
205
287
|
* Moves the specified tag namespace to the specified compartment within the same tenancy.
|
|
206
288
|
* <p>
|
|
@@ -209,10 +291,11 @@ export declare class IdentityClient {
|
|
|
209
291
|
* <p>
|
|
210
292
|
Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
|
|
211
293
|
*
|
|
294
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
212
295
|
* @param ChangeTagNamespaceCompartmentRequest
|
|
213
296
|
* @return ChangeTagNamespaceCompartmentResponse
|
|
214
297
|
* @throws OciError when an error occurs
|
|
215
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
298
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ChangeTagNamespaceCompartment.ts.html |here} to see how to use ChangeTagNamespaceCompartment API.
|
|
216
299
|
*/
|
|
217
300
|
changeTagNamespaceCompartment(changeTagNamespaceCompartmentRequest: requests.ChangeTagNamespaceCompartmentRequest): Promise<responses.ChangeTagNamespaceCompartmentResponse>;
|
|
218
301
|
/**
|
|
@@ -227,10 +310,11 @@ export declare class IdentityClient {
|
|
|
227
310
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
228
311
|
* tenancy can use this operation to create an auth token for any user, including themselves.
|
|
229
312
|
*
|
|
313
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
230
314
|
* @param CreateAuthTokenRequest
|
|
231
315
|
* @return CreateAuthTokenResponse
|
|
232
316
|
* @throws OciError when an error occurs
|
|
233
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
317
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateAuthToken.ts.html |here} to see how to use CreateAuthToken API.
|
|
234
318
|
*/
|
|
235
319
|
createAuthToken(createAuthTokenRequest: requests.CreateAuthTokenRequest): Promise<responses.CreateAuthTokenResponse>;
|
|
236
320
|
/**
|
|
@@ -254,10 +338,11 @@ export declare class IdentityClient {
|
|
|
254
338
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
255
339
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
256
340
|
*
|
|
341
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
257
342
|
* @param CreateCompartmentRequest
|
|
258
343
|
* @return CreateCompartmentResponse
|
|
259
344
|
* @throws OciError when an error occurs
|
|
260
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
345
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateCompartment.ts.html |here} to see how to use CreateCompartment API.
|
|
261
346
|
*/
|
|
262
347
|
createCompartment(createCompartmentRequest: requests.CreateCompartmentRequest): Promise<responses.CreateCompartmentResponse>;
|
|
263
348
|
/**
|
|
@@ -273,12 +358,38 @@ export declare class IdentityClient {
|
|
|
273
358
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
274
359
|
* tenancy can use this operation to create a secret key for any user, including themselves.
|
|
275
360
|
*
|
|
361
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
276
362
|
* @param CreateCustomerSecretKeyRequest
|
|
277
363
|
* @return CreateCustomerSecretKeyResponse
|
|
278
364
|
* @throws OciError when an error occurs
|
|
279
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
365
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateCustomerSecretKey.ts.html |here} to see how to use CreateCustomerSecretKey API.
|
|
280
366
|
*/
|
|
281
367
|
createCustomerSecretKey(createCustomerSecretKeyRequest: requests.CreateCustomerSecretKeyRequest): Promise<responses.CreateCustomerSecretKeyResponse>;
|
|
368
|
+
/**
|
|
369
|
+
* Creates a new domain in the tenancy with domain home in {@code homeRegion}. This is an asynchronous call - where, at start,
|
|
370
|
+
* {@code lifecycleState} of this domain is set to CREATING and {@code lifecycleDetails} to UPDATING. On domain creation completion
|
|
371
|
+
* this Domain's {@code lifecycleState} will be set to ACTIVE and {@code lifecycleDetails} to null.
|
|
372
|
+
* <p>
|
|
373
|
+
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
374
|
+
* the async operation's status.
|
|
375
|
+
* <p>
|
|
376
|
+
After creating a `Domain`, make sure its `lifecycleState` changes from CREATING to ACTIVE
|
|
377
|
+
* before using it.
|
|
378
|
+
* If the domain's {@code displayName} already exists, returns 400 BAD REQUEST.
|
|
379
|
+
* If any one of admin related fields are provided and one of the following 3 fields
|
|
380
|
+
* - {@code adminEmail}, {@code adminLastName} and {@code adminUserName} - is not provided,
|
|
381
|
+
* returns 400 BAD REQUEST.
|
|
382
|
+
* - If {@code isNotificationBypassed} is NOT provided when admin information is provided,
|
|
383
|
+
* returns 400 BAD REQUEST.
|
|
384
|
+
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
385
|
+
*
|
|
386
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
387
|
+
* @param CreateDomainRequest
|
|
388
|
+
* @return CreateDomainResponse
|
|
389
|
+
* @throws OciError when an error occurs
|
|
390
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateDomain.ts.html |here} to see how to use CreateDomain API.
|
|
391
|
+
*/
|
|
392
|
+
createDomain(createDomainRequest: requests.CreateDomainRequest): Promise<responses.CreateDomainResponse>;
|
|
282
393
|
/**
|
|
283
394
|
* Creates a new dynamic group in your tenancy.
|
|
284
395
|
* <p>
|
|
@@ -299,10 +410,11 @@ export declare class IdentityClient {
|
|
|
299
410
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
300
411
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
301
412
|
*
|
|
413
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
302
414
|
* @param CreateDynamicGroupRequest
|
|
303
415
|
* @return CreateDynamicGroupResponse
|
|
304
416
|
* @throws OciError when an error occurs
|
|
305
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
417
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateDynamicGroup.ts.html |here} to see how to use CreateDynamicGroup API.
|
|
306
418
|
*/
|
|
307
419
|
createDynamicGroup(createDynamicGroupRequest: requests.CreateDynamicGroupRequest): Promise<responses.CreateDynamicGroupResponse>;
|
|
308
420
|
/**
|
|
@@ -328,14 +440,17 @@ export declare class IdentityClient {
|
|
|
328
440
|
* See {@link #addUserToGroup(AddUserToGroupRequest) addUserToGroup} and
|
|
329
441
|
* {@link #createPolicy(CreatePolicyRequest) createPolicy}.
|
|
330
442
|
*
|
|
443
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
331
444
|
* @param CreateGroupRequest
|
|
332
445
|
* @return CreateGroupResponse
|
|
333
446
|
* @throws OciError when an error occurs
|
|
334
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
447
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateGroup.ts.html |here} to see how to use CreateGroup API.
|
|
335
448
|
*/
|
|
336
449
|
createGroup(createGroupRequest: requests.CreateGroupRequest): Promise<responses.CreateGroupResponse>;
|
|
337
450
|
/**
|
|
338
|
-
*
|
|
451
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
452
|
+
* <p>
|
|
453
|
+
Creates a new identity provider in your tenancy. For more information, see
|
|
339
454
|
* [Identity Providers and Federation](https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm).
|
|
340
455
|
* <p>
|
|
341
456
|
You must specify your tenancy's OCID as the compartment ID in the request object.
|
|
@@ -354,29 +469,34 @@ export declare class IdentityClient {
|
|
|
354
469
|
* be CREATING. Before using the object, first make sure its `lifecycleState` has
|
|
355
470
|
* changed to ACTIVE.
|
|
356
471
|
*
|
|
472
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
357
473
|
* @param CreateIdentityProviderRequest
|
|
358
474
|
* @return CreateIdentityProviderResponse
|
|
359
475
|
* @throws OciError when an error occurs
|
|
360
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
476
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateIdentityProvider.ts.html |here} to see how to use CreateIdentityProvider API.
|
|
361
477
|
*/
|
|
362
478
|
createIdentityProvider(createIdentityProviderRequest: requests.CreateIdentityProviderRequest): Promise<responses.CreateIdentityProviderResponse>;
|
|
363
479
|
/**
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
480
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
481
|
+
* <p>
|
|
482
|
+
Creates a single mapping between an IdP group and an IAM Service
|
|
483
|
+
* {@link Group}.
|
|
484
|
+
*
|
|
485
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
486
|
+
* @param CreateIdpGroupMappingRequest
|
|
487
|
+
* @return CreateIdpGroupMappingResponse
|
|
488
|
+
* @throws OciError when an error occurs
|
|
489
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateIdpGroupMapping.ts.html |here} to see how to use CreateIdpGroupMapping API.
|
|
490
|
+
*/
|
|
372
491
|
createIdpGroupMapping(createIdpGroupMappingRequest: requests.CreateIdpGroupMappingRequest): Promise<responses.CreateIdpGroupMappingResponse>;
|
|
373
492
|
/**
|
|
374
493
|
* Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.
|
|
375
494
|
*
|
|
495
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
376
496
|
* @param CreateMfaTotpDeviceRequest
|
|
377
497
|
* @return CreateMfaTotpDeviceResponse
|
|
378
498
|
* @throws OciError when an error occurs
|
|
379
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
499
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateMfaTotpDevice.ts.html |here} to see how to use CreateMfaTotpDevice API.
|
|
380
500
|
*/
|
|
381
501
|
createMfaTotpDevice(createMfaTotpDeviceRequest: requests.CreateMfaTotpDeviceRequest): Promise<responses.CreateMfaTotpDeviceResponse>;
|
|
382
502
|
/**
|
|
@@ -402,19 +522,21 @@ export declare class IdentityClient {
|
|
|
402
522
|
After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed
|
|
403
523
|
* 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
524
|
*
|
|
525
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
405
526
|
* @param CreateNetworkSourceRequest
|
|
406
527
|
* @return CreateNetworkSourceResponse
|
|
407
528
|
* @throws OciError when an error occurs
|
|
408
|
-
* @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.1/identity/CreateNetworkSource.ts.html |here} to see how to use CreateNetworkSource API.
|
|
409
530
|
*/
|
|
410
531
|
createNetworkSource(createNetworkSourceRequest: requests.CreateNetworkSourceRequest): Promise<responses.CreateNetworkSourceResponse>;
|
|
411
532
|
/**
|
|
412
533
|
* Creates Oauth token for the user
|
|
413
534
|
*
|
|
535
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
414
536
|
* @param CreateOAuthClientCredentialRequest
|
|
415
537
|
* @return CreateOAuthClientCredentialResponse
|
|
416
538
|
* @throws OciError when an error occurs
|
|
417
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
539
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateOAuthClientCredential.ts.html |here} to see how to use CreateOAuthClientCredential API.
|
|
418
540
|
*/
|
|
419
541
|
createOAuthClientCredential(createOAuthClientCredentialRequest: requests.CreateOAuthClientCredentialRequest): Promise<responses.CreateOAuthClientCredentialResponse>;
|
|
420
542
|
/**
|
|
@@ -430,10 +552,11 @@ export declare class IdentityClient {
|
|
|
430
552
|
**Note:** The user's Console login is the unique name you specified when you created the user
|
|
431
553
|
* (see {@link #createUser(CreateUserRequest) createUser}).
|
|
432
554
|
*
|
|
555
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
433
556
|
* @param CreateOrResetUIPasswordRequest
|
|
434
557
|
* @return CreateOrResetUIPasswordResponse
|
|
435
558
|
* @throws OciError when an error occurs
|
|
436
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
559
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateOrResetUIPassword.ts.html |here} to see how to use CreateOrResetUIPassword API.
|
|
437
560
|
*/
|
|
438
561
|
createOrResetUIPassword(createOrResetUIPasswordRequest: requests.CreateOrResetUIPasswordRequest): Promise<responses.CreateOrResetUIPasswordResponse>;
|
|
439
562
|
/**
|
|
@@ -455,19 +578,21 @@ export declare class IdentityClient {
|
|
|
455
578
|
* <p>
|
|
456
579
|
New policies take effect typically within 10 seconds.
|
|
457
580
|
*
|
|
581
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
458
582
|
* @param CreatePolicyRequest
|
|
459
583
|
* @return CreatePolicyResponse
|
|
460
584
|
* @throws OciError when an error occurs
|
|
461
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
585
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreatePolicy.ts.html |here} to see how to use CreatePolicy API.
|
|
462
586
|
*/
|
|
463
587
|
createPolicy(createPolicyRequest: requests.CreatePolicyRequest): Promise<responses.CreatePolicyResponse>;
|
|
464
588
|
/**
|
|
465
589
|
* Creates a subscription to a region for a tenancy.
|
|
466
590
|
*
|
|
591
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
467
592
|
* @param CreateRegionSubscriptionRequest
|
|
468
593
|
* @return CreateRegionSubscriptionResponse
|
|
469
594
|
* @throws OciError when an error occurs
|
|
470
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
595
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateRegionSubscription.ts.html |here} to see how to use CreateRegionSubscription API.
|
|
471
596
|
*/
|
|
472
597
|
createRegionSubscription(createRegionSubscriptionRequest: requests.CreateRegionSubscriptionRequest): Promise<responses.CreateRegionSubscriptionResponse>;
|
|
473
598
|
/**
|
|
@@ -476,10 +601,11 @@ export declare class IdentityClient {
|
|
|
476
601
|
* have to be unique, and you can change it anytime with
|
|
477
602
|
* {@link #updateSmtpCredential(UpdateSmtpCredentialRequest) updateSmtpCredential}.
|
|
478
603
|
*
|
|
604
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
479
605
|
* @param CreateSmtpCredentialRequest
|
|
480
606
|
* @return CreateSmtpCredentialResponse
|
|
481
607
|
* @throws OciError when an error occurs
|
|
482
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
608
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateSmtpCredential.ts.html |here} to see how to use CreateSmtpCredential API.
|
|
483
609
|
*/
|
|
484
610
|
createSmtpCredential(createSmtpCredentialRequest: requests.CreateSmtpCredentialRequest): Promise<responses.CreateSmtpCredentialResponse>;
|
|
485
611
|
/**
|
|
@@ -496,10 +622,11 @@ export declare class IdentityClient {
|
|
|
496
622
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
497
623
|
* tenancy can use this operation to create a Swift password for any user, including themselves.
|
|
498
624
|
*
|
|
625
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
499
626
|
* @param CreateSwiftPasswordRequest
|
|
500
627
|
* @return CreateSwiftPasswordResponse
|
|
501
628
|
* @throws OciError when an error occurs
|
|
502
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
629
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateSwiftPassword.ts.html |here} to see how to use CreateSwiftPassword API.
|
|
503
630
|
*/
|
|
504
631
|
createSwiftPassword(createSwiftPasswordRequest: requests.CreateSwiftPasswordRequest): Promise<responses.CreateSwiftPasswordResponse>;
|
|
505
632
|
/**
|
|
@@ -526,10 +653,11 @@ export declare class IdentityClient {
|
|
|
526
653
|
* * If a `validator` is set, the user applying the tag to a resource must select from a list
|
|
527
654
|
* of values that you supply with {@link #enumTagDefinitionValidator(EnumTagDefinitionValidatorRequest) enumTagDefinitionValidator}.
|
|
528
655
|
*
|
|
656
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
529
657
|
* @param CreateTagRequest
|
|
530
658
|
* @return CreateTagResponse
|
|
531
659
|
* @throws OciError when an error occurs
|
|
532
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
660
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateTag.ts.html |here} to see how to use CreateTag API.
|
|
533
661
|
*/
|
|
534
662
|
createTag(createTagRequest: requests.CreateTagRequest): Promise<responses.CreateTagResponse>;
|
|
535
663
|
/**
|
|
@@ -542,10 +670,11 @@ export declare class IdentityClient {
|
|
|
542
670
|
* If the `isRequired` flag is set to \"true\", the value is set during resource creation.
|
|
543
671
|
* * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
|
|
544
672
|
*
|
|
673
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
545
674
|
* @param CreateTagDefaultRequest
|
|
546
675
|
* @return CreateTagDefaultResponse
|
|
547
676
|
* @throws OciError when an error occurs
|
|
548
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
677
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateTagDefault.ts.html |here} to see how to use CreateTagDefault API.
|
|
549
678
|
*/
|
|
550
679
|
createTagDefault(createTagDefaultRequest: requests.CreateTagDefaultRequest): Promise<responses.CreateTagDefaultResponse>;
|
|
551
680
|
/**
|
|
@@ -564,10 +693,11 @@ export declare class IdentityClient {
|
|
|
564
693
|
* It does not have to be unique, and you can change it with
|
|
565
694
|
* {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}.
|
|
566
695
|
*
|
|
696
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
567
697
|
* @param CreateTagNamespaceRequest
|
|
568
698
|
* @return CreateTagNamespaceResponse
|
|
569
699
|
* @throws OciError when an error occurs
|
|
570
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
700
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateTagNamespace.ts.html |here} to see how to use CreateTagNamespace API.
|
|
571
701
|
*/
|
|
572
702
|
createTagNamespace(createTagNamespaceRequest: requests.CreateTagNamespaceRequest): Promise<responses.CreateTagNamespaceResponse>;
|
|
573
703
|
/**
|
|
@@ -607,12 +737,40 @@ export declare class IdentityClient {
|
|
|
607
737
|
* <p>
|
|
608
738
|
**Important:** Make sure to inform the new user which compartment(s) they have access to.
|
|
609
739
|
*
|
|
740
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
610
741
|
* @param CreateUserRequest
|
|
611
742
|
* @return CreateUserResponse
|
|
612
743
|
* @throws OciError when an error occurs
|
|
613
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
744
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/CreateUser.ts.html |here} to see how to use CreateUser API.
|
|
614
745
|
*/
|
|
615
746
|
createUser(createUserRequest: requests.CreateUserRequest): Promise<responses.CreateUserResponse>;
|
|
747
|
+
/**
|
|
748
|
+
* If the domain's {@code lifecycleState} is ACTIVE and no active Apps are present in domain,
|
|
749
|
+
* 1. Set the {@code lifecycleDetails} to DEACTIVATING and asynchronously starts disabling
|
|
750
|
+
* the domain and return 202 ACCEPTED.
|
|
751
|
+
* 1.1 Sets the domain status to DISABLED and set specified domain's
|
|
752
|
+
* {@code lifecycleState} to INACTIVE and set the {@code lifecycleDetails} to null.
|
|
753
|
+
* <p>
|
|
754
|
+
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
755
|
+
* the async operation's status. Activate a domain can be done using HTTP POST
|
|
756
|
+
* /domains/{domainId}/actions/activate.
|
|
757
|
+
* <p>
|
|
758
|
+
- If the domain's {@code lifecycleState} is INACTIVE, returns 202 ACCEPTED with no action
|
|
759
|
+
* taken on service side.
|
|
760
|
+
* - If domain is of {@code type} DEFAULT or DEFAULT_LIGHTWEIGHT or domain's {@code lifecycleState}
|
|
761
|
+
* is not ACTIVE, returns 400 BAD REQUEST.
|
|
762
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
763
|
+
* - If any active Apps in domain, returns 400 BAD REQUEST.
|
|
764
|
+
* - If the authenticated user is part of the domain to be activated, returns 400 BAD REQUEST
|
|
765
|
+
* - If error occurs while deactivating domain, returns 500 INTERNAL SERVER ERROR.
|
|
766
|
+
*
|
|
767
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
768
|
+
* @param DeactivateDomainRequest
|
|
769
|
+
* @return DeactivateDomainResponse
|
|
770
|
+
* @throws OciError when an error occurs
|
|
771
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeactivateDomain.ts.html |here} to see how to use DeactivateDomain API.
|
|
772
|
+
*/
|
|
773
|
+
deactivateDomain(deactivateDomainRequest: requests.DeactivateDomainRequest): Promise<responses.DeactivateDomainResponse>;
|
|
616
774
|
/**
|
|
617
775
|
* Deletes the specified API signing key for the specified user.
|
|
618
776
|
* <p>
|
|
@@ -621,117 +779,161 @@ export declare class IdentityClient {
|
|
|
621
779
|
* To compare, administrators who have permission to the tenancy can use this operation to delete
|
|
622
780
|
* a key for any user, including themselves.
|
|
623
781
|
*
|
|
782
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
624
783
|
* @param DeleteApiKeyRequest
|
|
625
784
|
* @return DeleteApiKeyResponse
|
|
626
785
|
* @throws OciError when an error occurs
|
|
627
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
786
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteApiKey.ts.html |here} to see how to use DeleteApiKey API.
|
|
628
787
|
*/
|
|
629
788
|
deleteApiKey(deleteApiKeyRequest: requests.DeleteApiKeyRequest): Promise<responses.DeleteApiKeyResponse>;
|
|
630
789
|
/**
|
|
631
790
|
* Deletes the specified auth token for the specified user.
|
|
632
791
|
*
|
|
792
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
633
793
|
* @param DeleteAuthTokenRequest
|
|
634
794
|
* @return DeleteAuthTokenResponse
|
|
635
795
|
* @throws OciError when an error occurs
|
|
636
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
796
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteAuthToken.ts.html |here} to see how to use DeleteAuthToken API.
|
|
637
797
|
*/
|
|
638
798
|
deleteAuthToken(deleteAuthTokenRequest: requests.DeleteAuthTokenRequest): Promise<responses.DeleteAuthTokenResponse>;
|
|
639
799
|
/**
|
|
640
800
|
* Deletes the specified compartment. The compartment must be empty.
|
|
641
801
|
*
|
|
802
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
642
803
|
* @param DeleteCompartmentRequest
|
|
643
804
|
* @return DeleteCompartmentResponse
|
|
644
805
|
* @throws OciError when an error occurs
|
|
645
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
806
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteCompartment.ts.html |here} to see how to use DeleteCompartment API.
|
|
646
807
|
*/
|
|
647
808
|
deleteCompartment(deleteCompartmentRequest: requests.DeleteCompartmentRequest): Promise<responses.DeleteCompartmentResponse>;
|
|
648
809
|
/**
|
|
649
810
|
* Deletes the specified secret key for the specified user.
|
|
650
811
|
*
|
|
812
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
651
813
|
* @param DeleteCustomerSecretKeyRequest
|
|
652
814
|
* @return DeleteCustomerSecretKeyResponse
|
|
653
815
|
* @throws OciError when an error occurs
|
|
654
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
816
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteCustomerSecretKey.ts.html |here} to see how to use DeleteCustomerSecretKey API.
|
|
655
817
|
*/
|
|
656
818
|
deleteCustomerSecretKey(deleteCustomerSecretKeyRequest: requests.DeleteCustomerSecretKeyRequest): Promise<responses.DeleteCustomerSecretKeyResponse>;
|
|
819
|
+
/**
|
|
820
|
+
* Soft Deletes a domain.
|
|
821
|
+
* <p>
|
|
822
|
+
This is an asynchronous API, where, if the domain's {@code lifecycleState} is INACTIVE and
|
|
823
|
+
* no active Apps are present in underlying stripe,
|
|
824
|
+
* 1. Sets the specified domain's {@code lifecycleState} to DELETING.
|
|
825
|
+
* 2. Domains marked as DELETING will be cleaned up by a periodic task unless customer request it to be undo via ticket.
|
|
826
|
+
* 3. Work request is created and returned as opc-work-request-id along with 202 ACCEPTED.
|
|
827
|
+
* To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
828
|
+
* the async operation's status.
|
|
829
|
+
* <p>
|
|
830
|
+
- If the domain's {@code lifecycleState} is DELETING, returns 202 Accepted as a deletion
|
|
831
|
+
* is already in progress for this domain.
|
|
832
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
833
|
+
* - If domain is of {@code type} DEFAULT or DEFAULT_LIGHTWEIGHT, returns 400 BAD REQUEST.
|
|
834
|
+
* - If any active Apps in domain, returns 400 BAD REQUEST.
|
|
835
|
+
* - If the authenticated user is part of the domain to be deleted, returns 400 BAD REQUEST.
|
|
836
|
+
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
837
|
+
*
|
|
838
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
839
|
+
* @param DeleteDomainRequest
|
|
840
|
+
* @return DeleteDomainResponse
|
|
841
|
+
* @throws OciError when an error occurs
|
|
842
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteDomain.ts.html |here} to see how to use DeleteDomain API.
|
|
843
|
+
*/
|
|
844
|
+
deleteDomain(deleteDomainRequest: requests.DeleteDomainRequest): Promise<responses.DeleteDomainResponse>;
|
|
657
845
|
/**
|
|
658
846
|
* Deletes the specified dynamic group.
|
|
659
847
|
*
|
|
848
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
660
849
|
* @param DeleteDynamicGroupRequest
|
|
661
850
|
* @return DeleteDynamicGroupResponse
|
|
662
851
|
* @throws OciError when an error occurs
|
|
663
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
852
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteDynamicGroup.ts.html |here} to see how to use DeleteDynamicGroup API.
|
|
664
853
|
*/
|
|
665
854
|
deleteDynamicGroup(deleteDynamicGroupRequest: requests.DeleteDynamicGroupRequest): Promise<responses.DeleteDynamicGroupResponse>;
|
|
666
855
|
/**
|
|
667
856
|
* Deletes the specified group. The group must be empty.
|
|
668
857
|
*
|
|
858
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
669
859
|
* @param DeleteGroupRequest
|
|
670
860
|
* @return DeleteGroupResponse
|
|
671
861
|
* @throws OciError when an error occurs
|
|
672
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
862
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteGroup.ts.html |here} to see how to use DeleteGroup API.
|
|
673
863
|
*/
|
|
674
864
|
deleteGroup(deleteGroupRequest: requests.DeleteGroupRequest): Promise<responses.DeleteGroupResponse>;
|
|
675
865
|
/**
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
866
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
867
|
+
* <p>
|
|
868
|
+
Deletes the specified identity provider. The identity provider must not have
|
|
869
|
+
* any group mappings (see {@link IdpGroupMapping}).
|
|
870
|
+
*
|
|
871
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
872
|
+
* @param DeleteIdentityProviderRequest
|
|
873
|
+
* @return DeleteIdentityProviderResponse
|
|
874
|
+
* @throws OciError when an error occurs
|
|
875
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteIdentityProvider.ts.html |here} to see how to use DeleteIdentityProvider API.
|
|
876
|
+
*/
|
|
684
877
|
deleteIdentityProvider(deleteIdentityProviderRequest: requests.DeleteIdentityProviderRequest): Promise<responses.DeleteIdentityProviderResponse>;
|
|
685
878
|
/**
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
879
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
880
|
+
* <p>
|
|
881
|
+
Deletes the specified group mapping.
|
|
882
|
+
*
|
|
883
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
884
|
+
* @param DeleteIdpGroupMappingRequest
|
|
885
|
+
* @return DeleteIdpGroupMappingResponse
|
|
886
|
+
* @throws OciError when an error occurs
|
|
887
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteIdpGroupMapping.ts.html |here} to see how to use DeleteIdpGroupMapping API.
|
|
888
|
+
*/
|
|
692
889
|
deleteIdpGroupMapping(deleteIdpGroupMappingRequest: requests.DeleteIdpGroupMappingRequest): Promise<responses.DeleteIdpGroupMappingResponse>;
|
|
693
890
|
/**
|
|
694
891
|
* Deletes the specified MFA TOTP device for the specified user.
|
|
695
892
|
*
|
|
893
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
696
894
|
* @param DeleteMfaTotpDeviceRequest
|
|
697
895
|
* @return DeleteMfaTotpDeviceResponse
|
|
698
896
|
* @throws OciError when an error occurs
|
|
699
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
897
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteMfaTotpDevice.ts.html |here} to see how to use DeleteMfaTotpDevice API.
|
|
700
898
|
*/
|
|
701
899
|
deleteMfaTotpDevice(deleteMfaTotpDeviceRequest: requests.DeleteMfaTotpDeviceRequest): Promise<responses.DeleteMfaTotpDeviceResponse>;
|
|
702
900
|
/**
|
|
703
901
|
* Deletes the specified network source
|
|
704
902
|
*
|
|
903
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
705
904
|
* @param DeleteNetworkSourceRequest
|
|
706
905
|
* @return DeleteNetworkSourceResponse
|
|
707
906
|
* @throws OciError when an error occurs
|
|
708
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
907
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteNetworkSource.ts.html |here} to see how to use DeleteNetworkSource API.
|
|
709
908
|
*/
|
|
710
909
|
deleteNetworkSource(deleteNetworkSourceRequest: requests.DeleteNetworkSourceRequest): Promise<responses.DeleteNetworkSourceResponse>;
|
|
711
910
|
/**
|
|
712
911
|
* Delete Oauth token for the user
|
|
713
912
|
*
|
|
913
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
714
914
|
* @param DeleteOAuthClientCredentialRequest
|
|
715
915
|
* @return DeleteOAuthClientCredentialResponse
|
|
716
916
|
* @throws OciError when an error occurs
|
|
717
|
-
* @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.1/identity/DeleteOAuthClientCredential.ts.html |here} to see how to use DeleteOAuthClientCredential API.
|
|
718
918
|
*/
|
|
719
919
|
deleteOAuthClientCredential(deleteOAuthClientCredentialRequest: requests.DeleteOAuthClientCredentialRequest): Promise<responses.DeleteOAuthClientCredentialResponse>;
|
|
720
920
|
/**
|
|
721
921
|
* Deletes the specified policy. The deletion takes effect typically within 10 seconds.
|
|
922
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
722
923
|
* @param DeletePolicyRequest
|
|
723
924
|
* @return DeletePolicyResponse
|
|
724
925
|
* @throws OciError when an error occurs
|
|
725
|
-
* @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.1/identity/DeletePolicy.ts.html |here} to see how to use DeletePolicy API.
|
|
726
927
|
*/
|
|
727
928
|
deletePolicy(deletePolicyRequest: requests.DeletePolicyRequest): Promise<responses.DeletePolicyResponse>;
|
|
728
929
|
/**
|
|
729
930
|
* Deletes the specified SMTP credential for the specified user.
|
|
730
931
|
*
|
|
932
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
731
933
|
* @param DeleteSmtpCredentialRequest
|
|
732
934
|
* @return DeleteSmtpCredentialResponse
|
|
733
935
|
* @throws OciError when an error occurs
|
|
734
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
936
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteSmtpCredential.ts.html |here} to see how to use DeleteSmtpCredential API.
|
|
735
937
|
*/
|
|
736
938
|
deleteSmtpCredential(deleteSmtpCredentialRequest: requests.DeleteSmtpCredentialRequest): Promise<responses.DeleteSmtpCredentialResponse>;
|
|
737
939
|
/**
|
|
@@ -739,10 +941,11 @@ export declare class IdentityClient {
|
|
|
739
941
|
* <p>
|
|
740
942
|
Deletes the specified Swift password for the specified user.
|
|
741
943
|
*
|
|
944
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
742
945
|
* @param DeleteSwiftPasswordRequest
|
|
743
946
|
* @return DeleteSwiftPasswordResponse
|
|
744
947
|
* @throws OciError when an error occurs
|
|
745
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
948
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteSwiftPassword.ts.html |here} to see how to use DeleteSwiftPassword API.
|
|
746
949
|
*/
|
|
747
950
|
deleteSwiftPassword(deleteSwiftPasswordRequest: requests.DeleteSwiftPasswordRequest): Promise<responses.DeleteSwiftPasswordResponse>;
|
|
748
951
|
/**
|
|
@@ -768,19 +971,21 @@ export declare class IdentityClient {
|
|
|
768
971
|
To delete a tag, you must first retire it. Use {@link #updateTag(UpdateTagRequest) updateTag}
|
|
769
972
|
* to retire a tag.
|
|
770
973
|
*
|
|
974
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
771
975
|
* @param DeleteTagRequest
|
|
772
976
|
* @return DeleteTagResponse
|
|
773
977
|
* @throws OciError when an error occurs
|
|
774
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
978
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteTag.ts.html |here} to see how to use DeleteTag API.
|
|
775
979
|
*/
|
|
776
980
|
deleteTag(deleteTagRequest: requests.DeleteTagRequest): Promise<responses.DeleteTagResponse>;
|
|
777
981
|
/**
|
|
778
982
|
* Deletes the the specified tag default.
|
|
779
983
|
*
|
|
984
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
780
985
|
* @param DeleteTagDefaultRequest
|
|
781
986
|
* @return DeleteTagDefaultResponse
|
|
782
987
|
* @throws OciError when an error occurs
|
|
783
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
988
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/DeleteTagDefault.ts.html |here} to see how to use DeleteTagDefault API.
|
|
784
989
|
*/
|
|
785
990
|
deleteTagDefault(deleteTagDefaultRequest: requests.DeleteTagDefaultRequest): Promise<responses.DeleteTagDefaultResponse>;
|
|
786
991
|
/**
|
|
@@ -792,37 +997,63 @@ export declare class IdentityClient {
|
|
|
792
997
|
* <p>
|
|
793
998
|
Use {@link #deleteTag(DeleteTagRequest) deleteTag} to delete a tag definition.
|
|
794
999
|
*
|
|
1000
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
795
1001
|
* @param DeleteTagNamespaceRequest
|
|
796
1002
|
* @return DeleteTagNamespaceResponse
|
|
797
1003
|
* @throws OciError when an error occurs
|
|
798
|
-
* @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.1/identity/DeleteTagNamespace.ts.html |here} to see how to use DeleteTagNamespace API.
|
|
799
1005
|
*/
|
|
800
1006
|
deleteTagNamespace(deleteTagNamespaceRequest: requests.DeleteTagNamespaceRequest): Promise<responses.DeleteTagNamespaceResponse>;
|
|
801
1007
|
/**
|
|
802
1008
|
* Deletes the specified user. The user must not be in any groups.
|
|
1009
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
803
1010
|
* @param DeleteUserRequest
|
|
804
1011
|
* @return DeleteUserResponse
|
|
805
1012
|
* @throws OciError when an error occurs
|
|
806
|
-
* @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.1/identity/DeleteUser.ts.html |here} to see how to use DeleteUser API.
|
|
807
1014
|
*/
|
|
808
1015
|
deleteUser(deleteUserRequest: requests.DeleteUserRequest): Promise<responses.DeleteUserResponse>;
|
|
1016
|
+
/**
|
|
1017
|
+
* Replicate domain to a new region. This is an asynchronous call - where, at start,
|
|
1018
|
+
* {@code state} of this domain in replica region is set to ENABLING_REPLICATION.
|
|
1019
|
+
* On domain replication completion the {@code state} will be set to REPLICATION_ENABLED.
|
|
1020
|
+
* <p>
|
|
1021
|
+
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
1022
|
+
* the async operation's status.
|
|
1023
|
+
* <p>
|
|
1024
|
+
If the replica region's {@code state} is already ENABLING_REPLICATION or REPLICATION_ENABLED,
|
|
1025
|
+
* returns 409 CONFLICT.
|
|
1026
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
1027
|
+
* - If home region is same as replication region, return 400 BAD REQUEST.
|
|
1028
|
+
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
1029
|
+
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
1030
|
+
*
|
|
1031
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1032
|
+
* @param EnableReplicationToRegionRequest
|
|
1033
|
+
* @return EnableReplicationToRegionResponse
|
|
1034
|
+
* @throws OciError when an error occurs
|
|
1035
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/EnableReplicationToRegion.ts.html |here} to see how to use EnableReplicationToRegion API.
|
|
1036
|
+
*/
|
|
1037
|
+
enableReplicationToRegion(enableReplicationToRegionRequest: requests.EnableReplicationToRegionRequest): Promise<responses.EnableReplicationToRegionResponse>;
|
|
809
1038
|
/**
|
|
810
1039
|
* Generate seed for the MFA TOTP device.
|
|
811
1040
|
*
|
|
1041
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
812
1042
|
* @param GenerateTotpSeedRequest
|
|
813
1043
|
* @return GenerateTotpSeedResponse
|
|
814
1044
|
* @throws OciError when an error occurs
|
|
815
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1045
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GenerateTotpSeed.ts.html |here} to see how to use GenerateTotpSeed API.
|
|
816
1046
|
*/
|
|
817
1047
|
generateTotpSeed(generateTotpSeedRequest: requests.GenerateTotpSeedRequest): Promise<responses.GenerateTotpSeedResponse>;
|
|
818
1048
|
/**
|
|
819
1049
|
* Gets the authentication policy for the given tenancy. You must specify your tenant\u2019s OCID as the value for
|
|
820
1050
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
821
1051
|
*
|
|
1052
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
822
1053
|
* @param GetAuthenticationPolicyRequest
|
|
823
1054
|
* @return GetAuthenticationPolicyResponse
|
|
824
1055
|
* @throws OciError when an error occurs
|
|
825
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1056
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetAuthenticationPolicy.ts.html |here} to see how to use GetAuthenticationPolicy API.
|
|
826
1057
|
*/
|
|
827
1058
|
getAuthenticationPolicy(getAuthenticationPolicyRequest: requests.GetAuthenticationPolicyRequest): Promise<responses.GetAuthenticationPolicyResponse>;
|
|
828
1059
|
/**
|
|
@@ -835,19 +1066,34 @@ export declare class IdentityClient {
|
|
|
835
1066
|
* call the {@link #listInstances(ListInstancesRequest) listInstances} operation in the Cloud Compute
|
|
836
1067
|
* Service or the {@link #listVolumes(ListVolumesRequest) listVolumes} operation in Cloud Block Storage.
|
|
837
1068
|
*
|
|
1069
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
838
1070
|
* @param GetCompartmentRequest
|
|
839
1071
|
* @return GetCompartmentResponse
|
|
840
1072
|
* @throws OciError when an error occurs
|
|
841
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1073
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetCompartment.ts.html |here} to see how to use GetCompartment API.
|
|
842
1074
|
*/
|
|
843
1075
|
getCompartment(getCompartmentRequest: requests.GetCompartmentRequest): Promise<responses.GetCompartmentResponse>;
|
|
1076
|
+
/**
|
|
1077
|
+
* Get the specified domain's information.
|
|
1078
|
+
* <p>
|
|
1079
|
+
- If the domain doesn't exists, returns 404 NOT FOUND.
|
|
1080
|
+
* - If any internal error occurs, returns 500 INTERNAL SERVER ERROR.
|
|
1081
|
+
*
|
|
1082
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1083
|
+
* @param GetDomainRequest
|
|
1084
|
+
* @return GetDomainResponse
|
|
1085
|
+
* @throws OciError when an error occurs
|
|
1086
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetDomain.ts.html |here} to see how to use GetDomain API.
|
|
1087
|
+
*/
|
|
1088
|
+
getDomain(getDomainRequest: requests.GetDomainRequest): Promise<responses.GetDomainResponse>;
|
|
844
1089
|
/**
|
|
845
1090
|
* Gets the specified dynamic group's information.
|
|
846
1091
|
*
|
|
1092
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
847
1093
|
* @param GetDynamicGroupRequest
|
|
848
1094
|
* @return GetDynamicGroupResponse
|
|
849
1095
|
* @throws OciError when an error occurs
|
|
850
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1096
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetDynamicGroup.ts.html |here} to see how to use GetDynamicGroup API.
|
|
851
1097
|
*/
|
|
852
1098
|
getDynamicGroup(getDynamicGroupRequest: requests.GetDynamicGroupRequest): Promise<responses.GetDynamicGroupResponse>;
|
|
853
1099
|
/**
|
|
@@ -857,154 +1103,207 @@ export declare class IdentityClient {
|
|
|
857
1103
|
* {@link #listUserGroupMemberships(ListUserGroupMembershipsRequest) listUserGroupMemberships} and
|
|
858
1104
|
* provide the group's OCID as a query parameter in the request.
|
|
859
1105
|
*
|
|
1106
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
860
1107
|
* @param GetGroupRequest
|
|
861
1108
|
* @return GetGroupResponse
|
|
862
1109
|
* @throws OciError when an error occurs
|
|
863
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1110
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetGroup.ts.html |here} to see how to use GetGroup API.
|
|
864
1111
|
*/
|
|
865
1112
|
getGroup(getGroupRequest: requests.GetGroupRequest): Promise<responses.GetGroupResponse>;
|
|
866
1113
|
/**
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
1114
|
+
* Gets details on a specified IAM work request. For asynchronous operations in Identity and Access Management service, opc-work-request-id header values contains
|
|
1115
|
+
* iam work request id that can be provided in this API to track the current status of the operation.
|
|
1116
|
+
* <p>
|
|
1117
|
+
- If workrequest exists, returns 202 ACCEPTED
|
|
1118
|
+
* - If workrequest does not exist, returns 404 NOT FOUND
|
|
1119
|
+
*
|
|
1120
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1121
|
+
* @param GetIamWorkRequestRequest
|
|
1122
|
+
* @return GetIamWorkRequestResponse
|
|
1123
|
+
* @throws OciError when an error occurs
|
|
1124
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetIamWorkRequest.ts.html |here} to see how to use GetIamWorkRequest API.
|
|
1125
|
+
*/
|
|
1126
|
+
getIamWorkRequest(getIamWorkRequestRequest: requests.GetIamWorkRequestRequest): Promise<responses.GetIamWorkRequestResponse>;
|
|
1127
|
+
/**
|
|
1128
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
1129
|
+
* <p>
|
|
1130
|
+
Gets the specified identity provider's information.
|
|
1131
|
+
*
|
|
1132
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1133
|
+
* @param GetIdentityProviderRequest
|
|
1134
|
+
* @return GetIdentityProviderResponse
|
|
1135
|
+
* @throws OciError when an error occurs
|
|
1136
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetIdentityProvider.ts.html |here} to see how to use GetIdentityProvider API.
|
|
1137
|
+
*/
|
|
873
1138
|
getIdentityProvider(getIdentityProviderRequest: requests.GetIdentityProviderRequest): Promise<responses.GetIdentityProviderResponse>;
|
|
874
1139
|
/**
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
1140
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
1141
|
+
* <p>
|
|
1142
|
+
Gets the specified group mapping.
|
|
1143
|
+
*
|
|
1144
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1145
|
+
* @param GetIdpGroupMappingRequest
|
|
1146
|
+
* @return GetIdpGroupMappingResponse
|
|
1147
|
+
* @throws OciError when an error occurs
|
|
1148
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetIdpGroupMapping.ts.html |here} to see how to use GetIdpGroupMapping API.
|
|
1149
|
+
*/
|
|
881
1150
|
getIdpGroupMapping(getIdpGroupMappingRequest: requests.GetIdpGroupMappingRequest): Promise<responses.GetIdpGroupMappingResponse>;
|
|
882
1151
|
/**
|
|
883
1152
|
* Get the specified MFA TOTP device for the specified user.
|
|
884
1153
|
*
|
|
1154
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
885
1155
|
* @param GetMfaTotpDeviceRequest
|
|
886
1156
|
* @return GetMfaTotpDeviceResponse
|
|
887
1157
|
* @throws OciError when an error occurs
|
|
888
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1158
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetMfaTotpDevice.ts.html |here} to see how to use GetMfaTotpDevice API.
|
|
889
1159
|
*/
|
|
890
1160
|
getMfaTotpDevice(getMfaTotpDeviceRequest: requests.GetMfaTotpDeviceRequest): Promise<responses.GetMfaTotpDeviceResponse>;
|
|
891
1161
|
/**
|
|
892
1162
|
* Gets the specified network source's information.
|
|
893
1163
|
*
|
|
1164
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
894
1165
|
* @param GetNetworkSourceRequest
|
|
895
1166
|
* @return GetNetworkSourceResponse
|
|
896
1167
|
* @throws OciError when an error occurs
|
|
897
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1168
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetNetworkSource.ts.html |here} to see how to use GetNetworkSource API.
|
|
898
1169
|
*/
|
|
899
1170
|
getNetworkSource(getNetworkSourceRequest: requests.GetNetworkSourceRequest): Promise<responses.GetNetworkSourceResponse>;
|
|
900
1171
|
/**
|
|
901
1172
|
* Gets the specified policy's information.
|
|
1173
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
902
1174
|
* @param GetPolicyRequest
|
|
903
1175
|
* @return GetPolicyResponse
|
|
904
1176
|
* @throws OciError when an error occurs
|
|
905
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1177
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetPolicy.ts.html |here} to see how to use GetPolicy API.
|
|
906
1178
|
*/
|
|
907
1179
|
getPolicy(getPolicyRequest: requests.GetPolicyRequest): Promise<responses.GetPolicyResponse>;
|
|
908
1180
|
/**
|
|
909
1181
|
* Gets the specified tag's information.
|
|
1182
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
910
1183
|
* @param GetTagRequest
|
|
911
1184
|
* @return GetTagResponse
|
|
912
1185
|
* @throws OciError when an error occurs
|
|
913
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1186
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetTag.ts.html |here} to see how to use GetTag API.
|
|
914
1187
|
*/
|
|
915
1188
|
getTag(getTagRequest: requests.GetTagRequest): Promise<responses.GetTagResponse>;
|
|
916
1189
|
/**
|
|
917
1190
|
* Retrieves the specified tag default.
|
|
918
1191
|
*
|
|
1192
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
919
1193
|
* @param GetTagDefaultRequest
|
|
920
1194
|
* @return GetTagDefaultResponse
|
|
921
1195
|
* @throws OciError when an error occurs
|
|
922
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1196
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetTagDefault.ts.html |here} to see how to use GetTagDefault API.
|
|
923
1197
|
*/
|
|
924
1198
|
getTagDefault(getTagDefaultRequest: requests.GetTagDefaultRequest): Promise<responses.GetTagDefaultResponse>;
|
|
925
1199
|
/**
|
|
926
1200
|
* Gets the specified tag namespace's information.
|
|
927
1201
|
*
|
|
1202
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
928
1203
|
* @param GetTagNamespaceRequest
|
|
929
1204
|
* @return GetTagNamespaceResponse
|
|
930
1205
|
* @throws OciError when an error occurs
|
|
931
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1206
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetTagNamespace.ts.html |here} to see how to use GetTagNamespace API.
|
|
932
1207
|
*/
|
|
933
1208
|
getTagNamespace(getTagNamespaceRequest: requests.GetTagNamespaceRequest): Promise<responses.GetTagNamespaceResponse>;
|
|
934
1209
|
/**
|
|
935
1210
|
* Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header
|
|
936
|
-
* for any asynchronous operation in
|
|
1211
|
+
* for any asynchronous operation in tagging service.
|
|
937
1212
|
*
|
|
1213
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
938
1214
|
* @param GetTaggingWorkRequestRequest
|
|
939
1215
|
* @return GetTaggingWorkRequestResponse
|
|
940
1216
|
* @throws OciError when an error occurs
|
|
941
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1217
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetTaggingWorkRequest.ts.html |here} to see how to use GetTaggingWorkRequest API.
|
|
942
1218
|
*/
|
|
943
1219
|
getTaggingWorkRequest(getTaggingWorkRequestRequest: requests.GetTaggingWorkRequestRequest): Promise<responses.GetTaggingWorkRequestResponse>;
|
|
944
1220
|
/**
|
|
945
1221
|
* Get the specified tenancy's information.
|
|
1222
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
946
1223
|
* @param GetTenancyRequest
|
|
947
1224
|
* @return GetTenancyResponse
|
|
948
1225
|
* @throws OciError when an error occurs
|
|
949
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1226
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetTenancy.ts.html |here} to see how to use GetTenancy API.
|
|
950
1227
|
*/
|
|
951
1228
|
getTenancy(getTenancyRequest: requests.GetTenancyRequest): Promise<responses.GetTenancyResponse>;
|
|
952
1229
|
/**
|
|
953
1230
|
* Gets the specified user's information.
|
|
1231
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
954
1232
|
* @param GetUserRequest
|
|
955
1233
|
* @return GetUserResponse
|
|
956
1234
|
* @throws OciError when an error occurs
|
|
957
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1235
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetUser.ts.html |here} to see how to use GetUser API.
|
|
958
1236
|
*/
|
|
959
1237
|
getUser(getUserRequest: requests.GetUserRequest): Promise<responses.GetUserResponse>;
|
|
960
1238
|
/**
|
|
961
1239
|
* Gets the specified UserGroupMembership's information.
|
|
1240
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
962
1241
|
* @param GetUserGroupMembershipRequest
|
|
963
1242
|
* @return GetUserGroupMembershipResponse
|
|
964
1243
|
* @throws OciError when an error occurs
|
|
965
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1244
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetUserGroupMembership.ts.html |here} to see how to use GetUserGroupMembership API.
|
|
966
1245
|
*/
|
|
967
1246
|
getUserGroupMembership(getUserGroupMembershipRequest: requests.GetUserGroupMembershipRequest): Promise<responses.GetUserGroupMembershipResponse>;
|
|
968
1247
|
/**
|
|
969
1248
|
* Gets the specified user's console password information. The returned object contains the user's OCID,
|
|
970
1249
|
* but not the password itself. The actual password is returned only when created or reset.
|
|
971
1250
|
*
|
|
1251
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
972
1252
|
* @param GetUserUIPasswordInformationRequest
|
|
973
1253
|
* @return GetUserUIPasswordInformationResponse
|
|
974
1254
|
* @throws OciError when an error occurs
|
|
975
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1255
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetUserUIPasswordInformation.ts.html |here} to see how to use GetUserUIPasswordInformation API.
|
|
976
1256
|
*/
|
|
977
1257
|
getUserUIPasswordInformation(getUserUIPasswordInformationRequest: requests.GetUserUIPasswordInformationRequest): Promise<responses.GetUserUIPasswordInformationResponse>;
|
|
978
1258
|
/**
|
|
979
1259
|
* Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header
|
|
980
|
-
* for any asynchronous operation in the
|
|
1260
|
+
* for any asynchronous operation in the compartment service.
|
|
981
1261
|
*
|
|
1262
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
982
1263
|
* @param GetWorkRequestRequest
|
|
983
1264
|
* @return GetWorkRequestResponse
|
|
984
1265
|
* @throws OciError when an error occurs
|
|
985
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1266
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
986
1267
|
*/
|
|
987
1268
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
1269
|
+
/**
|
|
1270
|
+
* List the allowed domain license types supported by OCI
|
|
1271
|
+
* If {@code currentLicenseTypeName} provided, returns allowed license types a domain with the specified license type name can migrate to.
|
|
1272
|
+
* If {@code name} is provided, it filters and returns resources that match the given license type name.
|
|
1273
|
+
* Otherwise, returns all valid license types that are currently supported.
|
|
1274
|
+
* <p>
|
|
1275
|
+
- If license type details are retrieved sucessfully, return 202 ACCEPTED.
|
|
1276
|
+
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
1277
|
+
*
|
|
1278
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1279
|
+
* @param ListAllowedDomainLicenseTypesRequest
|
|
1280
|
+
* @return ListAllowedDomainLicenseTypesResponse
|
|
1281
|
+
* @throws OciError when an error occurs
|
|
1282
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListAllowedDomainLicenseTypes.ts.html |here} to see how to use ListAllowedDomainLicenseTypes API.
|
|
1283
|
+
*/
|
|
1284
|
+
listAllowedDomainLicenseTypes(listAllowedDomainLicenseTypesRequest: requests.ListAllowedDomainLicenseTypesRequest): Promise<responses.ListAllowedDomainLicenseTypesResponse>;
|
|
988
1285
|
/**
|
|
989
1286
|
* Lists the API signing keys for the specified user. A user can have a maximum of three keys.
|
|
990
1287
|
* <p>
|
|
991
1288
|
Every user has permission to use this API call for *their own user ID*. An administrator in your
|
|
992
1289
|
* organization does not need to write a policy to give users this ability.
|
|
993
1290
|
*
|
|
1291
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
994
1292
|
* @param ListApiKeysRequest
|
|
995
1293
|
* @return ListApiKeysResponse
|
|
996
1294
|
* @throws OciError when an error occurs
|
|
997
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1295
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListApiKeys.ts.html |here} to see how to use ListApiKeys API.
|
|
998
1296
|
*/
|
|
999
1297
|
listApiKeys(listApiKeysRequest: requests.ListApiKeysRequest): Promise<responses.ListApiKeysResponse>;
|
|
1000
1298
|
/**
|
|
1001
1299
|
* Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not
|
|
1002
1300
|
* the token itself. The actual token is returned only upon creation.
|
|
1003
1301
|
*
|
|
1302
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1004
1303
|
* @param ListAuthTokensRequest
|
|
1005
1304
|
* @return ListAuthTokensResponse
|
|
1006
1305
|
* @throws OciError when an error occurs
|
|
1007
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1306
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListAuthTokens.ts.html |here} to see how to use ListAuthTokens API.
|
|
1008
1307
|
*/
|
|
1009
1308
|
listAuthTokens(listAuthTokensRequest: requests.ListAuthTokensRequest): Promise<responses.ListAuthTokensResponse>;
|
|
1010
1309
|
/**
|
|
@@ -1014,10 +1313,11 @@ export declare class IdentityClient {
|
|
|
1014
1313
|
* Note that the order of the results returned can change if availability domains are added or removed; therefore, do not
|
|
1015
1314
|
* create a dependency on the list order.
|
|
1016
1315
|
*
|
|
1316
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1017
1317
|
* @param ListAvailabilityDomainsRequest
|
|
1018
1318
|
* @return ListAvailabilityDomainsResponse
|
|
1019
1319
|
* @throws OciError when an error occurs
|
|
1020
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1320
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListAvailabilityDomains.ts.html |here} to see how to use ListAvailabilityDomains API.
|
|
1021
1321
|
*/
|
|
1022
1322
|
listAvailabilityDomains(listAvailabilityDomainsRequest: requests.ListAvailabilityDomainsRequest): Promise<responses.ListAvailabilityDomainsResponse>;
|
|
1023
1323
|
/**
|
|
@@ -1029,19 +1329,21 @@ export declare class IdentityClient {
|
|
|
1029
1329
|
* require an [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types,
|
|
1030
1330
|
* such as buckets, require you to provide other identifying information.
|
|
1031
1331
|
*
|
|
1332
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1032
1333
|
* @param ListBulkActionResourceTypesRequest
|
|
1033
1334
|
* @return ListBulkActionResourceTypesResponse
|
|
1034
1335
|
* @throws OciError when an error occurs
|
|
1035
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1336
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListBulkActionResourceTypes.ts.html |here} to see how to use ListBulkActionResourceTypes API.
|
|
1036
1337
|
*/
|
|
1037
1338
|
listBulkActionResourceTypes(listBulkActionResourceTypesRequest: requests.ListBulkActionResourceTypesRequest): Promise<responses.ListBulkActionResourceTypesResponse>;
|
|
1038
1339
|
/**
|
|
1039
1340
|
* Lists the resource types that support bulk tag editing.
|
|
1040
1341
|
*
|
|
1342
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1041
1343
|
* @param ListBulkEditTagsResourceTypesRequest
|
|
1042
1344
|
* @return ListBulkEditTagsResourceTypesResponse
|
|
1043
1345
|
* @throws OciError when an error occurs
|
|
1044
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1346
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListBulkEditTagsResourceTypes.ts.html |here} to see how to use ListBulkEditTagsResourceTypes API.
|
|
1045
1347
|
*/
|
|
1046
1348
|
listBulkEditTagsResourceTypes(listBulkEditTagsResourceTypesRequest: requests.ListBulkEditTagsResourceTypesRequest): Promise<responses.ListBulkEditTagsResourceTypesResponse>;
|
|
1047
1349
|
/**
|
|
@@ -1064,10 +1366,11 @@ export declare class IdentityClient {
|
|
|
1064
1366
|
* <p>
|
|
1065
1367
|
See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1066
1368
|
*
|
|
1369
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1067
1370
|
* @param ListCompartmentsRequest
|
|
1068
1371
|
* @return ListCompartmentsResponse
|
|
1069
1372
|
* @throws OciError when an error occurs
|
|
1070
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1373
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListCompartments.ts.html |here} to see how to use ListCompartments API.
|
|
1071
1374
|
*/
|
|
1072
1375
|
listCompartments(listCompartmentsRequest: requests.ListCompartmentsRequest): Promise<responses.ListCompartmentsResponse>;
|
|
1073
1376
|
/**
|
|
@@ -1106,10 +1409,11 @@ export declare class IdentityClient {
|
|
|
1106
1409
|
* Lists all the tags enabled for cost-tracking in the specified tenancy. For information about
|
|
1107
1410
|
* cost-tracking tags, see [Using Cost-tracking Tags](https://docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#costs).
|
|
1108
1411
|
*
|
|
1412
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1109
1413
|
* @param ListCostTrackingTagsRequest
|
|
1110
1414
|
* @return ListCostTrackingTagsResponse
|
|
1111
1415
|
* @throws OciError when an error occurs
|
|
1112
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1416
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListCostTrackingTags.ts.html |here} to see how to use ListCostTrackingTags API.
|
|
1113
1417
|
*/
|
|
1114
1418
|
listCostTrackingTags(listCostTrackingTagsRequest: requests.ListCostTrackingTagsRequest): Promise<responses.ListCostTrackingTagsResponse>;
|
|
1115
1419
|
/**
|
|
@@ -1148,21 +1452,66 @@ export declare class IdentityClient {
|
|
|
1148
1452
|
* Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not
|
|
1149
1453
|
* the secret key itself. The actual secret key is returned only upon creation.
|
|
1150
1454
|
*
|
|
1455
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1151
1456
|
* @param ListCustomerSecretKeysRequest
|
|
1152
1457
|
* @return ListCustomerSecretKeysResponse
|
|
1153
1458
|
* @throws OciError when an error occurs
|
|
1154
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1459
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListCustomerSecretKeys.ts.html |here} to see how to use ListCustomerSecretKeys API.
|
|
1155
1460
|
*/
|
|
1156
1461
|
listCustomerSecretKeys(listCustomerSecretKeysRequest: requests.ListCustomerSecretKeysRequest): Promise<responses.ListCustomerSecretKeysResponse>;
|
|
1462
|
+
/**
|
|
1463
|
+
* List all domains that are homed or have a replica region in current region.
|
|
1464
|
+
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
1465
|
+
*
|
|
1466
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1467
|
+
* @param ListDomainsRequest
|
|
1468
|
+
* @return ListDomainsResponse
|
|
1469
|
+
* @throws OciError when an error occurs
|
|
1470
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListDomains.ts.html |here} to see how to use ListDomains API.
|
|
1471
|
+
*/
|
|
1472
|
+
listDomains(listDomainsRequest: requests.ListDomainsRequest): Promise<responses.ListDomainsResponse>;
|
|
1473
|
+
/**
|
|
1474
|
+
* NOTE: This function is deprecated in favor of listDomainsRecordIterator function.
|
|
1475
|
+
* Creates a new async iterator which will iterate over the models.DomainSummary objects
|
|
1476
|
+
* contained in responses from the listDomains operation. This iterator will fetch more data from the
|
|
1477
|
+
* server as needed.
|
|
1478
|
+
*
|
|
1479
|
+
* @param request a request which can be sent to the service operation
|
|
1480
|
+
*/
|
|
1481
|
+
listAllDomains(request: requests.ListDomainsRequest): AsyncIterableIterator<model.DomainSummary>;
|
|
1482
|
+
/**
|
|
1483
|
+
* NOTE: This function is deprecated in favor of listDomainsResponseIterator function.
|
|
1484
|
+
* Creates a new async iterator which will iterate over the responses received from the listDomains operation. This iterator
|
|
1485
|
+
* will fetch more data from the server as needed.
|
|
1486
|
+
*
|
|
1487
|
+
* @param request a request which can be sent to the service operation
|
|
1488
|
+
*/
|
|
1489
|
+
listAllDomainsResponses(request: requests.ListDomainsRequest): AsyncIterableIterator<responses.ListDomainsResponse>;
|
|
1490
|
+
/**
|
|
1491
|
+
* Creates a new async iterator which will iterate over the models.DomainSummary objects
|
|
1492
|
+
* contained in responses from the listDomains operation. This iterator will fetch more data from the
|
|
1493
|
+
* server as needed.
|
|
1494
|
+
*
|
|
1495
|
+
* @param request a request which can be sent to the service operation
|
|
1496
|
+
*/
|
|
1497
|
+
listDomainsRecordIterator(request: requests.ListDomainsRequest): AsyncIterableIterator<model.DomainSummary>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Creates a new async iterator which will iterate over the responses received from the listDomains operation. This iterator
|
|
1500
|
+
* will fetch more data from the server as needed.
|
|
1501
|
+
*
|
|
1502
|
+
* @param request a request which can be sent to the service operation
|
|
1503
|
+
*/
|
|
1504
|
+
listDomainsResponseIterator(request: requests.ListDomainsRequest): AsyncIterableIterator<responses.ListDomainsResponse>;
|
|
1157
1505
|
/**
|
|
1158
1506
|
* Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for
|
|
1159
1507
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1160
1508
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1161
1509
|
*
|
|
1510
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1162
1511
|
* @param ListDynamicGroupsRequest
|
|
1163
1512
|
* @return ListDynamicGroupsResponse
|
|
1164
1513
|
* @throws OciError when an error occurs
|
|
1165
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1514
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListDynamicGroups.ts.html |here} to see how to use ListDynamicGroups API.
|
|
1166
1515
|
*/
|
|
1167
1516
|
listDynamicGroups(listDynamicGroupsRequest: requests.ListDynamicGroupsRequest): Promise<responses.ListDynamicGroupsResponse>;
|
|
1168
1517
|
/**
|
|
@@ -1202,10 +1551,11 @@ export declare class IdentityClient {
|
|
|
1202
1551
|
* of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1203
1552
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1204
1553
|
*
|
|
1554
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1205
1555
|
* @param ListFaultDomainsRequest
|
|
1206
1556
|
* @return ListFaultDomainsResponse
|
|
1207
1557
|
* @throws OciError when an error occurs
|
|
1208
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1558
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListFaultDomains.ts.html |here} to see how to use ListFaultDomains API.
|
|
1209
1559
|
*/
|
|
1210
1560
|
listFaultDomains(listFaultDomainsRequest: requests.ListFaultDomainsRequest): Promise<responses.ListFaultDomainsResponse>;
|
|
1211
1561
|
/**
|
|
@@ -1213,10 +1563,11 @@ export declare class IdentityClient {
|
|
|
1213
1563
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1214
1564
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1215
1565
|
*
|
|
1566
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1216
1567
|
* @param ListGroupsRequest
|
|
1217
1568
|
* @return ListGroupsResponse
|
|
1218
1569
|
* @throws OciError when an error occurs
|
|
1219
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1570
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListGroups.ts.html |here} to see how to use ListGroups API.
|
|
1220
1571
|
*/
|
|
1221
1572
|
listGroups(listGroupsRequest: requests.ListGroupsRequest): Promise<responses.ListGroupsResponse>;
|
|
1222
1573
|
/**
|
|
@@ -1252,12 +1603,153 @@ export declare class IdentityClient {
|
|
|
1252
1603
|
*/
|
|
1253
1604
|
listGroupsResponseIterator(request: requests.ListGroupsRequest): AsyncIterableIterator<responses.ListGroupsResponse>;
|
|
1254
1605
|
/**
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1606
|
+
* Gets error details for a specified IAM work request. For asynchronous operations in Identity and Access Management service, opc-work-request-id header values contains
|
|
1607
|
+
* iam work request id that can be provided in this API to track the current status of the operation.
|
|
1608
|
+
* <p>
|
|
1609
|
+
- If workrequest exists, returns 202 ACCEPTED
|
|
1610
|
+
* - If workrequest does not exist, returns 404 NOT FOUND
|
|
1611
|
+
*
|
|
1612
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1613
|
+
* @param ListIamWorkRequestErrorsRequest
|
|
1614
|
+
* @return ListIamWorkRequestErrorsResponse
|
|
1615
|
+
* @throws OciError when an error occurs
|
|
1616
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListIamWorkRequestErrors.ts.html |here} to see how to use ListIamWorkRequestErrors API.
|
|
1617
|
+
*/
|
|
1618
|
+
listIamWorkRequestErrors(listIamWorkRequestErrorsRequest: requests.ListIamWorkRequestErrorsRequest): Promise<responses.ListIamWorkRequestErrorsResponse>;
|
|
1619
|
+
/**
|
|
1620
|
+
* NOTE: This function is deprecated in favor of listIamWorkRequestErrorsRecordIterator function.
|
|
1621
|
+
* Creates a new async iterator which will iterate over the models.IamWorkRequestErrorSummary objects
|
|
1622
|
+
* contained in responses from the listIamWorkRequestErrors operation. This iterator will fetch more data from the
|
|
1623
|
+
* server as needed.
|
|
1624
|
+
*
|
|
1625
|
+
* @param request a request which can be sent to the service operation
|
|
1626
|
+
*/
|
|
1627
|
+
listAllIamWorkRequestErrors(request: requests.ListIamWorkRequestErrorsRequest): AsyncIterableIterator<model.IamWorkRequestErrorSummary>;
|
|
1628
|
+
/**
|
|
1629
|
+
* NOTE: This function is deprecated in favor of listIamWorkRequestErrorsResponseIterator function.
|
|
1630
|
+
* Creates a new async iterator which will iterate over the responses received from the listIamWorkRequestErrors 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
|
+
listAllIamWorkRequestErrorsResponses(request: requests.ListIamWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListIamWorkRequestErrorsResponse>;
|
|
1636
|
+
/**
|
|
1637
|
+
* Creates a new async iterator which will iterate over the models.IamWorkRequestErrorSummary objects
|
|
1638
|
+
* contained in responses from the listIamWorkRequestErrors operation. This iterator will fetch more data from the
|
|
1639
|
+
* server as needed.
|
|
1640
|
+
*
|
|
1641
|
+
* @param request a request which can be sent to the service operation
|
|
1260
1642
|
*/
|
|
1643
|
+
listIamWorkRequestErrorsRecordIterator(request: requests.ListIamWorkRequestErrorsRequest): AsyncIterableIterator<model.IamWorkRequestErrorSummary>;
|
|
1644
|
+
/**
|
|
1645
|
+
* Creates a new async iterator which will iterate over the responses received from the listIamWorkRequestErrors operation. This iterator
|
|
1646
|
+
* will fetch more data from the server as needed.
|
|
1647
|
+
*
|
|
1648
|
+
* @param request a request which can be sent to the service operation
|
|
1649
|
+
*/
|
|
1650
|
+
listIamWorkRequestErrorsResponseIterator(request: requests.ListIamWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListIamWorkRequestErrorsResponse>;
|
|
1651
|
+
/**
|
|
1652
|
+
* Gets logs for a specified IAM work request. For asynchronous operations in Identity and Access Management service, opc-work-request-id header values contains
|
|
1653
|
+
* iam work request id that can be provided in this API to track the current status of the operation.
|
|
1654
|
+
* <p>
|
|
1655
|
+
- If workrequest exists, returns 202 ACCEPTED
|
|
1656
|
+
* - If workrequest does not exist, returns 404 NOT FOUND
|
|
1657
|
+
*
|
|
1658
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1659
|
+
* @param ListIamWorkRequestLogsRequest
|
|
1660
|
+
* @return ListIamWorkRequestLogsResponse
|
|
1661
|
+
* @throws OciError when an error occurs
|
|
1662
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListIamWorkRequestLogs.ts.html |here} to see how to use ListIamWorkRequestLogs API.
|
|
1663
|
+
*/
|
|
1664
|
+
listIamWorkRequestLogs(listIamWorkRequestLogsRequest: requests.ListIamWorkRequestLogsRequest): Promise<responses.ListIamWorkRequestLogsResponse>;
|
|
1665
|
+
/**
|
|
1666
|
+
* NOTE: This function is deprecated in favor of listIamWorkRequestLogsRecordIterator function.
|
|
1667
|
+
* Creates a new async iterator which will iterate over the models.IamWorkRequestLogSummary objects
|
|
1668
|
+
* contained in responses from the listIamWorkRequestLogs operation. This iterator will fetch more data from the
|
|
1669
|
+
* server as needed.
|
|
1670
|
+
*
|
|
1671
|
+
* @param request a request which can be sent to the service operation
|
|
1672
|
+
*/
|
|
1673
|
+
listAllIamWorkRequestLogs(request: requests.ListIamWorkRequestLogsRequest): AsyncIterableIterator<model.IamWorkRequestLogSummary>;
|
|
1674
|
+
/**
|
|
1675
|
+
* NOTE: This function is deprecated in favor of listIamWorkRequestLogsResponseIterator function.
|
|
1676
|
+
* Creates a new async iterator which will iterate over the responses received from the listIamWorkRequestLogs operation. This iterator
|
|
1677
|
+
* will fetch more data from the server as needed.
|
|
1678
|
+
*
|
|
1679
|
+
* @param request a request which can be sent to the service operation
|
|
1680
|
+
*/
|
|
1681
|
+
listAllIamWorkRequestLogsResponses(request: requests.ListIamWorkRequestLogsRequest): AsyncIterableIterator<responses.ListIamWorkRequestLogsResponse>;
|
|
1682
|
+
/**
|
|
1683
|
+
* Creates a new async iterator which will iterate over the models.IamWorkRequestLogSummary objects
|
|
1684
|
+
* contained in responses from the listIamWorkRequestLogs operation. This iterator will fetch more data from the
|
|
1685
|
+
* server as needed.
|
|
1686
|
+
*
|
|
1687
|
+
* @param request a request which can be sent to the service operation
|
|
1688
|
+
*/
|
|
1689
|
+
listIamWorkRequestLogsRecordIterator(request: requests.ListIamWorkRequestLogsRequest): AsyncIterableIterator<model.IamWorkRequestLogSummary>;
|
|
1690
|
+
/**
|
|
1691
|
+
* Creates a new async iterator which will iterate over the responses received from the listIamWorkRequestLogs operation. This iterator
|
|
1692
|
+
* will fetch more data from the server as needed.
|
|
1693
|
+
*
|
|
1694
|
+
* @param request a request which can be sent to the service operation
|
|
1695
|
+
*/
|
|
1696
|
+
listIamWorkRequestLogsResponseIterator(request: requests.ListIamWorkRequestLogsRequest): AsyncIterableIterator<responses.ListIamWorkRequestLogsResponse>;
|
|
1697
|
+
/**
|
|
1698
|
+
* List the IAM work requests in compartment
|
|
1699
|
+
* <p>
|
|
1700
|
+
- If IAM workrequest details are retrieved sucessfully, return 202 ACCEPTED.
|
|
1701
|
+
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
1702
|
+
*
|
|
1703
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1704
|
+
* @param ListIamWorkRequestsRequest
|
|
1705
|
+
* @return ListIamWorkRequestsResponse
|
|
1706
|
+
* @throws OciError when an error occurs
|
|
1707
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListIamWorkRequests.ts.html |here} to see how to use ListIamWorkRequests API.
|
|
1708
|
+
*/
|
|
1709
|
+
listIamWorkRequests(listIamWorkRequestsRequest: requests.ListIamWorkRequestsRequest): Promise<responses.ListIamWorkRequestsResponse>;
|
|
1710
|
+
/**
|
|
1711
|
+
* NOTE: This function is deprecated in favor of listIamWorkRequestsRecordIterator function.
|
|
1712
|
+
* Creates a new async iterator which will iterate over the models.IamWorkRequestSummary objects
|
|
1713
|
+
* contained in responses from the listIamWorkRequests operation. This iterator will fetch more data from the
|
|
1714
|
+
* server as needed.
|
|
1715
|
+
*
|
|
1716
|
+
* @param request a request which can be sent to the service operation
|
|
1717
|
+
*/
|
|
1718
|
+
listAllIamWorkRequests(request: requests.ListIamWorkRequestsRequest): AsyncIterableIterator<model.IamWorkRequestSummary>;
|
|
1719
|
+
/**
|
|
1720
|
+
* NOTE: This function is deprecated in favor of listIamWorkRequestsResponseIterator function.
|
|
1721
|
+
* Creates a new async iterator which will iterate over the responses received from the listIamWorkRequests operation. This iterator
|
|
1722
|
+
* will fetch more data from the server as needed.
|
|
1723
|
+
*
|
|
1724
|
+
* @param request a request which can be sent to the service operation
|
|
1725
|
+
*/
|
|
1726
|
+
listAllIamWorkRequestsResponses(request: requests.ListIamWorkRequestsRequest): AsyncIterableIterator<responses.ListIamWorkRequestsResponse>;
|
|
1727
|
+
/**
|
|
1728
|
+
* Creates a new async iterator which will iterate over the models.IamWorkRequestSummary objects
|
|
1729
|
+
* contained in responses from the listIamWorkRequests operation. This iterator will fetch more data from the
|
|
1730
|
+
* server as needed.
|
|
1731
|
+
*
|
|
1732
|
+
* @param request a request which can be sent to the service operation
|
|
1733
|
+
*/
|
|
1734
|
+
listIamWorkRequestsRecordIterator(request: requests.ListIamWorkRequestsRequest): AsyncIterableIterator<model.IamWorkRequestSummary>;
|
|
1735
|
+
/**
|
|
1736
|
+
* Creates a new async iterator which will iterate over the responses received from the listIamWorkRequests operation. This iterator
|
|
1737
|
+
* will fetch more data from the server as needed.
|
|
1738
|
+
*
|
|
1739
|
+
* @param request a request which can be sent to the service operation
|
|
1740
|
+
*/
|
|
1741
|
+
listIamWorkRequestsResponseIterator(request: requests.ListIamWorkRequestsRequest): AsyncIterableIterator<responses.ListIamWorkRequestsResponse>;
|
|
1742
|
+
/**
|
|
1743
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
1744
|
+
* <p>
|
|
1745
|
+
Lists the identity provider groups.
|
|
1746
|
+
*
|
|
1747
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1748
|
+
* @param ListIdentityProviderGroupsRequest
|
|
1749
|
+
* @return ListIdentityProviderGroupsResponse
|
|
1750
|
+
* @throws OciError when an error occurs
|
|
1751
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListIdentityProviderGroups.ts.html |here} to see how to use ListIdentityProviderGroups API.
|
|
1752
|
+
*/
|
|
1261
1753
|
listIdentityProviderGroups(listIdentityProviderGroupsRequest: requests.ListIdentityProviderGroupsRequest): Promise<responses.ListIdentityProviderGroupsResponse>;
|
|
1262
1754
|
/**
|
|
1263
1755
|
* NOTE: This function is deprecated in favor of listIdentityProviderGroupsRecordIterator function.
|
|
@@ -1292,16 +1784,19 @@ export declare class IdentityClient {
|
|
|
1292
1784
|
*/
|
|
1293
1785
|
listIdentityProviderGroupsResponseIterator(request: requests.ListIdentityProviderGroupsRequest): AsyncIterableIterator<responses.ListIdentityProviderGroupsResponse>;
|
|
1294
1786
|
/**
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1787
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
1788
|
+
* <p>
|
|
1789
|
+
Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for
|
|
1790
|
+
* identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the
|
|
1791
|
+
* compartment ID (remember that the tenancy is simply the root compartment).
|
|
1792
|
+
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1793
|
+
*
|
|
1794
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1795
|
+
* @param ListIdentityProvidersRequest
|
|
1796
|
+
* @return ListIdentityProvidersResponse
|
|
1797
|
+
* @throws OciError when an error occurs
|
|
1798
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListIdentityProviders.ts.html |here} to see how to use ListIdentityProviders API.
|
|
1799
|
+
*/
|
|
1305
1800
|
listIdentityProviders(listIdentityProvidersRequest: requests.ListIdentityProvidersRequest): Promise<responses.ListIdentityProvidersResponse>;
|
|
1306
1801
|
/**
|
|
1307
1802
|
* NOTE: This function is deprecated in favor of listIdentityProvidersRecordIterator function.
|
|
@@ -1336,13 +1831,16 @@ export declare class IdentityClient {
|
|
|
1336
1831
|
*/
|
|
1337
1832
|
listIdentityProvidersResponseIterator(request: requests.ListIdentityProvidersRequest): AsyncIterableIterator<responses.ListIdentityProvidersResponse>;
|
|
1338
1833
|
/**
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1834
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
1835
|
+
* <p>
|
|
1836
|
+
Lists the group mappings for the specified identity provider.
|
|
1837
|
+
*
|
|
1838
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1839
|
+
* @param ListIdpGroupMappingsRequest
|
|
1840
|
+
* @return ListIdpGroupMappingsResponse
|
|
1841
|
+
* @throws OciError when an error occurs
|
|
1842
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListIdpGroupMappings.ts.html |here} to see how to use ListIdpGroupMappings API.
|
|
1843
|
+
*/
|
|
1346
1844
|
listIdpGroupMappings(listIdpGroupMappingsRequest: requests.ListIdpGroupMappingsRequest): Promise<responses.ListIdpGroupMappingsResponse>;
|
|
1347
1845
|
/**
|
|
1348
1846
|
* NOTE: This function is deprecated in favor of listIdpGroupMappingsRecordIterator function.
|
|
@@ -1380,10 +1878,11 @@ export declare class IdentityClient {
|
|
|
1380
1878
|
* Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not
|
|
1381
1879
|
* the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.
|
|
1382
1880
|
*
|
|
1881
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1383
1882
|
* @param ListMfaTotpDevicesRequest
|
|
1384
1883
|
* @return ListMfaTotpDevicesResponse
|
|
1385
1884
|
* @throws OciError when an error occurs
|
|
1386
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1885
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListMfaTotpDevices.ts.html |here} to see how to use ListMfaTotpDevices API.
|
|
1387
1886
|
*/
|
|
1388
1887
|
listMfaTotpDevices(listMfaTotpDevicesRequest: requests.ListMfaTotpDevicesRequest): Promise<responses.ListMfaTotpDevicesResponse>;
|
|
1389
1888
|
/**
|
|
@@ -1423,10 +1922,11 @@ export declare class IdentityClient {
|
|
|
1423
1922
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1424
1923
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1425
1924
|
*
|
|
1925
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1426
1926
|
* @param ListNetworkSourcesRequest
|
|
1427
1927
|
* @return ListNetworkSourcesResponse
|
|
1428
1928
|
* @throws OciError when an error occurs
|
|
1429
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1929
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListNetworkSources.ts.html |here} to see how to use ListNetworkSources API.
|
|
1430
1930
|
*/
|
|
1431
1931
|
listNetworkSources(listNetworkSourcesRequest: requests.ListNetworkSourcesRequest): Promise<responses.ListNetworkSourcesResponse>;
|
|
1432
1932
|
/**
|
|
@@ -1464,10 +1964,11 @@ export declare class IdentityClient {
|
|
|
1464
1964
|
/**
|
|
1465
1965
|
* List of Oauth tokens for the user
|
|
1466
1966
|
*
|
|
1967
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1467
1968
|
* @param ListOAuthClientCredentialsRequest
|
|
1468
1969
|
* @return ListOAuthClientCredentialsResponse
|
|
1469
1970
|
* @throws OciError when an error occurs
|
|
1470
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1971
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListOAuthClientCredentials.ts.html |here} to see how to use ListOAuthClientCredentials API.
|
|
1471
1972
|
*/
|
|
1472
1973
|
listOAuthClientCredentials(listOAuthClientCredentialsRequest: requests.ListOAuthClientCredentialsRequest): Promise<responses.ListOAuthClientCredentialsResponse>;
|
|
1473
1974
|
/**
|
|
@@ -1509,10 +2010,11 @@ export declare class IdentityClient {
|
|
|
1509
2010
|
To determine which policies apply to a particular group or compartment, you must view the individual
|
|
1510
2011
|
* statements inside all your policies. There isn't a way to automatically obtain that information via the API.
|
|
1511
2012
|
*
|
|
2013
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1512
2014
|
* @param ListPoliciesRequest
|
|
1513
2015
|
* @return ListPoliciesResponse
|
|
1514
2016
|
* @throws OciError when an error occurs
|
|
1515
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2017
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListPolicies.ts.html |here} to see how to use ListPolicies API.
|
|
1516
2018
|
*/
|
|
1517
2019
|
listPolicies(listPoliciesRequest: requests.ListPoliciesRequest): Promise<responses.ListPoliciesResponse>;
|
|
1518
2020
|
/**
|
|
@@ -1549,28 +2051,31 @@ export declare class IdentityClient {
|
|
|
1549
2051
|
listPoliciesResponseIterator(request: requests.ListPoliciesRequest): AsyncIterableIterator<responses.ListPoliciesResponse>;
|
|
1550
2052
|
/**
|
|
1551
2053
|
* Lists the region subscriptions for the specified tenancy.
|
|
2054
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1552
2055
|
* @param ListRegionSubscriptionsRequest
|
|
1553
2056
|
* @return ListRegionSubscriptionsResponse
|
|
1554
2057
|
* @throws OciError when an error occurs
|
|
1555
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2058
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListRegionSubscriptions.ts.html |here} to see how to use ListRegionSubscriptions API.
|
|
1556
2059
|
*/
|
|
1557
2060
|
listRegionSubscriptions(listRegionSubscriptionsRequest: requests.ListRegionSubscriptionsRequest): Promise<responses.ListRegionSubscriptionsResponse>;
|
|
1558
2061
|
/**
|
|
1559
2062
|
* Lists all the regions offered by Oracle Cloud Infrastructure.
|
|
2063
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1560
2064
|
* @param ListRegionsRequest
|
|
1561
2065
|
* @return ListRegionsResponse
|
|
1562
2066
|
* @throws OciError when an error occurs
|
|
1563
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2067
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListRegions.ts.html |here} to see how to use ListRegions API.
|
|
1564
2068
|
*/
|
|
1565
2069
|
listRegions(listRegionsRequest: requests.ListRegionsRequest): Promise<responses.ListRegionsResponse>;
|
|
1566
2070
|
/**
|
|
1567
2071
|
* Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,
|
|
1568
2072
|
* the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.
|
|
1569
2073
|
*
|
|
2074
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1570
2075
|
* @param ListSmtpCredentialsRequest
|
|
1571
2076
|
* @return ListSmtpCredentialsResponse
|
|
1572
2077
|
* @throws OciError when an error occurs
|
|
1573
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2078
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListSmtpCredentials.ts.html |here} to see how to use ListSmtpCredentials API.
|
|
1574
2079
|
*/
|
|
1575
2080
|
listSmtpCredentials(listSmtpCredentialsRequest: requests.ListSmtpCredentialsRequest): Promise<responses.ListSmtpCredentialsResponse>;
|
|
1576
2081
|
/**
|
|
@@ -1579,19 +2084,21 @@ export declare class IdentityClient {
|
|
|
1579
2084
|
Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not
|
|
1580
2085
|
* the password itself. The actual password is returned only upon creation.
|
|
1581
2086
|
*
|
|
2087
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1582
2088
|
* @param ListSwiftPasswordsRequest
|
|
1583
2089
|
* @return ListSwiftPasswordsResponse
|
|
1584
2090
|
* @throws OciError when an error occurs
|
|
1585
|
-
* @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.1/identity/ListSwiftPasswords.ts.html |here} to see how to use ListSwiftPasswords API.
|
|
1586
2092
|
*/
|
|
1587
2093
|
listSwiftPasswords(listSwiftPasswordsRequest: requests.ListSwiftPasswordsRequest): Promise<responses.ListSwiftPasswordsResponse>;
|
|
1588
2094
|
/**
|
|
1589
2095
|
* Lists the tag defaults for tag definitions in the specified compartment.
|
|
1590
2096
|
*
|
|
2097
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1591
2098
|
* @param ListTagDefaultsRequest
|
|
1592
2099
|
* @return ListTagDefaultsResponse
|
|
1593
2100
|
* @throws OciError when an error occurs
|
|
1594
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2101
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListTagDefaults.ts.html |here} to see how to use ListTagDefaults API.
|
|
1595
2102
|
*/
|
|
1596
2103
|
listTagDefaults(listTagDefaultsRequest: requests.ListTagDefaultsRequest): Promise<responses.ListTagDefaultsResponse>;
|
|
1597
2104
|
/**
|
|
@@ -1629,10 +2136,11 @@ export declare class IdentityClient {
|
|
|
1629
2136
|
/**
|
|
1630
2137
|
* Lists the tag namespaces in the specified compartment.
|
|
1631
2138
|
*
|
|
2139
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1632
2140
|
* @param ListTagNamespacesRequest
|
|
1633
2141
|
* @return ListTagNamespacesResponse
|
|
1634
2142
|
* @throws OciError when an error occurs
|
|
1635
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2143
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListTagNamespaces.ts.html |here} to see how to use ListTagNamespaces API.
|
|
1636
2144
|
*/
|
|
1637
2145
|
listTagNamespaces(listTagNamespacesRequest: requests.ListTagNamespacesRequest): Promise<responses.ListTagNamespacesResponse>;
|
|
1638
2146
|
/**
|
|
@@ -1670,10 +2178,11 @@ export declare class IdentityClient {
|
|
|
1670
2178
|
/**
|
|
1671
2179
|
* Gets the errors for a work request.
|
|
1672
2180
|
*
|
|
2181
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1673
2182
|
* @param ListTaggingWorkRequestErrorsRequest
|
|
1674
2183
|
* @return ListTaggingWorkRequestErrorsResponse
|
|
1675
2184
|
* @throws OciError when an error occurs
|
|
1676
|
-
* @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.1/identity/ListTaggingWorkRequestErrors.ts.html |here} to see how to use ListTaggingWorkRequestErrors API.
|
|
1677
2186
|
*/
|
|
1678
2187
|
listTaggingWorkRequestErrors(listTaggingWorkRequestErrorsRequest: requests.ListTaggingWorkRequestErrorsRequest): Promise<responses.ListTaggingWorkRequestErrorsResponse>;
|
|
1679
2188
|
/**
|
|
@@ -1711,10 +2220,11 @@ export declare class IdentityClient {
|
|
|
1711
2220
|
/**
|
|
1712
2221
|
* Gets the logs for a work request.
|
|
1713
2222
|
*
|
|
2223
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1714
2224
|
* @param ListTaggingWorkRequestLogsRequest
|
|
1715
2225
|
* @return ListTaggingWorkRequestLogsResponse
|
|
1716
2226
|
* @throws OciError when an error occurs
|
|
1717
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2227
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListTaggingWorkRequestLogs.ts.html |here} to see how to use ListTaggingWorkRequestLogs API.
|
|
1718
2228
|
*/
|
|
1719
2229
|
listTaggingWorkRequestLogs(listTaggingWorkRequestLogsRequest: requests.ListTaggingWorkRequestLogsRequest): Promise<responses.ListTaggingWorkRequestLogsResponse>;
|
|
1720
2230
|
/**
|
|
@@ -1752,10 +2262,11 @@ export declare class IdentityClient {
|
|
|
1752
2262
|
/**
|
|
1753
2263
|
* Lists the tagging work requests in compartment.
|
|
1754
2264
|
*
|
|
2265
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1755
2266
|
* @param ListTaggingWorkRequestsRequest
|
|
1756
2267
|
* @return ListTaggingWorkRequestsResponse
|
|
1757
2268
|
* @throws OciError when an error occurs
|
|
1758
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2269
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListTaggingWorkRequests.ts.html |here} to see how to use ListTaggingWorkRequests API.
|
|
1759
2270
|
*/
|
|
1760
2271
|
listTaggingWorkRequests(listTaggingWorkRequestsRequest: requests.ListTaggingWorkRequestsRequest): Promise<responses.ListTaggingWorkRequestsResponse>;
|
|
1761
2272
|
/**
|
|
@@ -1793,10 +2304,11 @@ export declare class IdentityClient {
|
|
|
1793
2304
|
/**
|
|
1794
2305
|
* Lists the tag definitions in the specified tag namespace.
|
|
1795
2306
|
*
|
|
2307
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1796
2308
|
* @param ListTagsRequest
|
|
1797
2309
|
* @return ListTagsResponse
|
|
1798
2310
|
* @throws OciError when an error occurs
|
|
1799
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2311
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListTags.ts.html |here} to see how to use ListTags API.
|
|
1800
2312
|
*/
|
|
1801
2313
|
listTags(listTagsRequest: requests.ListTagsRequest): Promise<responses.ListTagsResponse>;
|
|
1802
2314
|
/**
|
|
@@ -1843,10 +2355,11 @@ export declare class IdentityClient {
|
|
|
1843
2355
|
* If the answer is no, the response is an empty list.
|
|
1844
2356
|
* - Although`userId` and `groupId` are not individually required, you must set one of them.
|
|
1845
2357
|
*
|
|
2358
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1846
2359
|
* @param ListUserGroupMembershipsRequest
|
|
1847
2360
|
* @return ListUserGroupMembershipsResponse
|
|
1848
2361
|
* @throws OciError when an error occurs
|
|
1849
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2362
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListUserGroupMemberships.ts.html |here} to see how to use ListUserGroupMemberships API.
|
|
1850
2363
|
*/
|
|
1851
2364
|
listUserGroupMemberships(listUserGroupMembershipsRequest: requests.ListUserGroupMembershipsRequest): Promise<responses.ListUserGroupMembershipsResponse>;
|
|
1852
2365
|
/**
|
|
@@ -1886,10 +2399,11 @@ export declare class IdentityClient {
|
|
|
1886
2399
|
* compartment ID (remember that the tenancy is simply the root compartment).
|
|
1887
2400
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1888
2401
|
*
|
|
2402
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1889
2403
|
* @param ListUsersRequest
|
|
1890
2404
|
* @return ListUsersResponse
|
|
1891
2405
|
* @throws OciError when an error occurs
|
|
1892
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2406
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListUsers.ts.html |here} to see how to use ListUsers API.
|
|
1893
2407
|
*/
|
|
1894
2408
|
listUsers(listUsersRequest: requests.ListUsersRequest): Promise<responses.ListUsersResponse>;
|
|
1895
2409
|
/**
|
|
@@ -1927,10 +2441,11 @@ export declare class IdentityClient {
|
|
|
1927
2441
|
/**
|
|
1928
2442
|
* Lists the work requests in compartment.
|
|
1929
2443
|
*
|
|
2444
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1930
2445
|
* @param ListWorkRequestsRequest
|
|
1931
2446
|
* @return ListWorkRequestsResponse
|
|
1932
2447
|
* @throws OciError when an error occurs
|
|
1933
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2448
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
1934
2449
|
*/
|
|
1935
2450
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
1936
2451
|
/**
|
|
@@ -1975,120 +2490,161 @@ export declare class IdentityClient {
|
|
|
1975
2490
|
* are aware of the implications for the compartment contents before you move it. For more
|
|
1976
2491
|
* information, see [Moving a Compartment](https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcompartments.htm#MoveCompartment).
|
|
1977
2492
|
*
|
|
2493
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1978
2494
|
* @param MoveCompartmentRequest
|
|
1979
2495
|
* @return MoveCompartmentResponse
|
|
1980
2496
|
* @throws OciError when an error occurs
|
|
1981
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2497
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/MoveCompartment.ts.html |here} to see how to use MoveCompartment API.
|
|
1982
2498
|
*/
|
|
1983
2499
|
moveCompartment(moveCompartmentRequest: requests.MoveCompartmentRequest): Promise<responses.MoveCompartmentResponse>;
|
|
1984
2500
|
/**
|
|
1985
2501
|
* Recover the compartment from DELETED state to ACTIVE state.
|
|
1986
2502
|
*
|
|
2503
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1987
2504
|
* @param RecoverCompartmentRequest
|
|
1988
2505
|
* @return RecoverCompartmentResponse
|
|
1989
2506
|
* @throws OciError when an error occurs
|
|
1990
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2507
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/RecoverCompartment.ts.html |here} to see how to use RecoverCompartment API.
|
|
1991
2508
|
*/
|
|
1992
2509
|
recoverCompartment(recoverCompartmentRequest: requests.RecoverCompartmentRequest): Promise<responses.RecoverCompartmentResponse>;
|
|
1993
2510
|
/**
|
|
1994
2511
|
* Removes a user from a group by deleting the corresponding `UserGroupMembership`.
|
|
2512
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1995
2513
|
* @param RemoveUserFromGroupRequest
|
|
1996
2514
|
* @return RemoveUserFromGroupResponse
|
|
1997
2515
|
* @throws OciError when an error occurs
|
|
1998
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2516
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/RemoveUserFromGroup.ts.html |here} to see how to use RemoveUserFromGroup API.
|
|
1999
2517
|
*/
|
|
2000
2518
|
removeUserFromGroup(removeUserFromGroupRequest: requests.RemoveUserFromGroupRequest): Promise<responses.RemoveUserFromGroupResponse>;
|
|
2001
2519
|
/**
|
|
2002
2520
|
* Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
|
|
2003
2521
|
*
|
|
2522
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2004
2523
|
* @param ResetIdpScimClientRequest
|
|
2005
2524
|
* @return ResetIdpScimClientResponse
|
|
2006
2525
|
* @throws OciError when an error occurs
|
|
2007
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2526
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/ResetIdpScimClient.ts.html |here} to see how to use ResetIdpScimClient API.
|
|
2008
2527
|
*/
|
|
2009
2528
|
resetIdpScimClient(resetIdpScimClientRequest: requests.ResetIdpScimClientRequest): Promise<responses.ResetIdpScimClientResponse>;
|
|
2010
2529
|
/**
|
|
2011
2530
|
* Updates the specified auth token's description.
|
|
2012
2531
|
*
|
|
2532
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2013
2533
|
* @param UpdateAuthTokenRequest
|
|
2014
2534
|
* @return UpdateAuthTokenResponse
|
|
2015
2535
|
* @throws OciError when an error occurs
|
|
2016
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2536
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateAuthToken.ts.html |here} to see how to use UpdateAuthToken API.
|
|
2017
2537
|
*/
|
|
2018
2538
|
updateAuthToken(updateAuthTokenRequest: requests.UpdateAuthTokenRequest): Promise<responses.UpdateAuthTokenResponse>;
|
|
2019
2539
|
/**
|
|
2020
2540
|
* Updates authentication policy for the specified tenancy
|
|
2021
2541
|
*
|
|
2542
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2022
2543
|
* @param UpdateAuthenticationPolicyRequest
|
|
2023
2544
|
* @return UpdateAuthenticationPolicyResponse
|
|
2024
2545
|
* @throws OciError when an error occurs
|
|
2025
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2546
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateAuthenticationPolicy.ts.html |here} to see how to use UpdateAuthenticationPolicy API.
|
|
2026
2547
|
*/
|
|
2027
2548
|
updateAuthenticationPolicy(updateAuthenticationPolicyRequest: requests.UpdateAuthenticationPolicyRequest): Promise<responses.UpdateAuthenticationPolicyResponse>;
|
|
2028
2549
|
/**
|
|
2029
2550
|
* Updates the specified compartment's description or name. You can't update the root compartment.
|
|
2551
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2030
2552
|
* @param UpdateCompartmentRequest
|
|
2031
2553
|
* @return UpdateCompartmentResponse
|
|
2032
2554
|
* @throws OciError when an error occurs
|
|
2033
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2555
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateCompartment.ts.html |here} to see how to use UpdateCompartment API.
|
|
2034
2556
|
*/
|
|
2035
2557
|
updateCompartment(updateCompartmentRequest: requests.UpdateCompartmentRequest): Promise<responses.UpdateCompartmentResponse>;
|
|
2036
2558
|
/**
|
|
2037
2559
|
* Updates the specified secret key's description.
|
|
2038
2560
|
*
|
|
2561
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2039
2562
|
* @param UpdateCustomerSecretKeyRequest
|
|
2040
2563
|
* @return UpdateCustomerSecretKeyResponse
|
|
2041
2564
|
* @throws OciError when an error occurs
|
|
2042
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2565
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateCustomerSecretKey.ts.html |here} to see how to use UpdateCustomerSecretKey API.
|
|
2043
2566
|
*/
|
|
2044
2567
|
updateCustomerSecretKey(updateCustomerSecretKeyRequest: requests.UpdateCustomerSecretKeyRequest): Promise<responses.UpdateCustomerSecretKeyResponse>;
|
|
2568
|
+
/**
|
|
2569
|
+
* Updates domain information and associated stripe. This is an asynchronous call where
|
|
2570
|
+
* the associated stripe and domain are updated.
|
|
2571
|
+
* <p>
|
|
2572
|
+
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
2573
|
+
* the async operation's status.
|
|
2574
|
+
* <p>
|
|
2575
|
+
- If the {@code displayName} is not unique within the tenancy, returns 400 BAD REQUEST.
|
|
2576
|
+
* - If any field other than {@code description} is requested to be updated for DEFAULT domain,
|
|
2577
|
+
* returns 400 BAD REQUEST.
|
|
2578
|
+
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
2579
|
+
* - If Domain {@code type} is DEFAULT or DEFAULT_LIGHTWEIGHT, return 400 BAD Request
|
|
2580
|
+
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
2581
|
+
*
|
|
2582
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2583
|
+
* @param UpdateDomainRequest
|
|
2584
|
+
* @return UpdateDomainResponse
|
|
2585
|
+
* @throws OciError when an error occurs
|
|
2586
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateDomain.ts.html |here} to see how to use UpdateDomain API.
|
|
2587
|
+
*/
|
|
2588
|
+
updateDomain(updateDomainRequest: requests.UpdateDomainRequest): Promise<responses.UpdateDomainResponse>;
|
|
2045
2589
|
/**
|
|
2046
2590
|
* Updates the specified dynamic group.
|
|
2591
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2047
2592
|
* @param UpdateDynamicGroupRequest
|
|
2048
2593
|
* @return UpdateDynamicGroupResponse
|
|
2049
2594
|
* @throws OciError when an error occurs
|
|
2050
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2595
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateDynamicGroup.ts.html |here} to see how to use UpdateDynamicGroup API.
|
|
2051
2596
|
*/
|
|
2052
2597
|
updateDynamicGroup(updateDynamicGroupRequest: requests.UpdateDynamicGroupRequest): Promise<responses.UpdateDynamicGroupResponse>;
|
|
2053
2598
|
/**
|
|
2054
2599
|
* Updates the specified group.
|
|
2600
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2055
2601
|
* @param UpdateGroupRequest
|
|
2056
2602
|
* @return UpdateGroupResponse
|
|
2057
2603
|
* @throws OciError when an error occurs
|
|
2058
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2604
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateGroup.ts.html |here} to see how to use UpdateGroup API.
|
|
2059
2605
|
*/
|
|
2060
2606
|
updateGroup(updateGroupRequest: requests.UpdateGroupRequest): Promise<responses.UpdateGroupResponse>;
|
|
2061
2607
|
/**
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
|
|
2608
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
2609
|
+
* <p>
|
|
2610
|
+
Updates the specified identity provider.
|
|
2611
|
+
*
|
|
2612
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2613
|
+
* @param UpdateIdentityProviderRequest
|
|
2614
|
+
* @return UpdateIdentityProviderResponse
|
|
2615
|
+
* @throws OciError when an error occurs
|
|
2616
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateIdentityProvider.ts.html |here} to see how to use UpdateIdentityProvider API.
|
|
2617
|
+
*/
|
|
2068
2618
|
updateIdentityProvider(updateIdentityProviderRequest: requests.UpdateIdentityProviderRequest): Promise<responses.UpdateIdentityProviderResponse>;
|
|
2069
2619
|
/**
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
|
|
2620
|
+
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
2621
|
+
* <p>
|
|
2622
|
+
Updates the specified group mapping.
|
|
2623
|
+
*
|
|
2624
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2625
|
+
* @param UpdateIdpGroupMappingRequest
|
|
2626
|
+
* @return UpdateIdpGroupMappingResponse
|
|
2627
|
+
* @throws OciError when an error occurs
|
|
2628
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateIdpGroupMapping.ts.html |here} to see how to use UpdateIdpGroupMapping API.
|
|
2629
|
+
*/
|
|
2076
2630
|
updateIdpGroupMapping(updateIdpGroupMappingRequest: requests.UpdateIdpGroupMappingRequest): Promise<responses.UpdateIdpGroupMappingResponse>;
|
|
2077
2631
|
/**
|
|
2078
2632
|
* Updates the specified network source.
|
|
2633
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2079
2634
|
* @param UpdateNetworkSourceRequest
|
|
2080
2635
|
* @return UpdateNetworkSourceResponse
|
|
2081
2636
|
* @throws OciError when an error occurs
|
|
2082
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2637
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateNetworkSource.ts.html |here} to see how to use UpdateNetworkSource API.
|
|
2083
2638
|
*/
|
|
2084
2639
|
updateNetworkSource(updateNetworkSourceRequest: requests.UpdateNetworkSourceRequest): Promise<responses.UpdateNetworkSourceResponse>;
|
|
2085
2640
|
/**
|
|
2086
2641
|
* Updates Oauth token for the user
|
|
2087
2642
|
*
|
|
2643
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2088
2644
|
* @param UpdateOAuthClientCredentialRequest
|
|
2089
2645
|
* @return UpdateOAuthClientCredentialResponse
|
|
2090
2646
|
* @throws OciError when an error occurs
|
|
2091
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2647
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateOAuthClientCredential.ts.html |here} to see how to use UpdateOAuthClientCredential API.
|
|
2092
2648
|
*/
|
|
2093
2649
|
updateOAuthClientCredential(updateOAuthClientCredentialRequest: requests.UpdateOAuthClientCredentialRequest): Promise<responses.UpdateOAuthClientCredentialResponse>;
|
|
2094
2650
|
/**
|
|
@@ -2096,19 +2652,21 @@ export declare class IdentityClient {
|
|
|
2096
2652
|
* <p>
|
|
2097
2653
|
Policy changes take effect typically within 10 seconds.
|
|
2098
2654
|
*
|
|
2655
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2099
2656
|
* @param UpdatePolicyRequest
|
|
2100
2657
|
* @return UpdatePolicyResponse
|
|
2101
2658
|
* @throws OciError when an error occurs
|
|
2102
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2659
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdatePolicy.ts.html |here} to see how to use UpdatePolicy API.
|
|
2103
2660
|
*/
|
|
2104
2661
|
updatePolicy(updatePolicyRequest: requests.UpdatePolicyRequest): Promise<responses.UpdatePolicyResponse>;
|
|
2105
2662
|
/**
|
|
2106
2663
|
* Updates the specified SMTP credential's description.
|
|
2107
2664
|
*
|
|
2665
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2108
2666
|
* @param UpdateSmtpCredentialRequest
|
|
2109
2667
|
* @return UpdateSmtpCredentialResponse
|
|
2110
2668
|
* @throws OciError when an error occurs
|
|
2111
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2669
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateSmtpCredential.ts.html |here} to see how to use UpdateSmtpCredential API.
|
|
2112
2670
|
*/
|
|
2113
2671
|
updateSmtpCredential(updateSmtpCredentialRequest: requests.UpdateSmtpCredentialRequest): Promise<responses.UpdateSmtpCredentialResponse>;
|
|
2114
2672
|
/**
|
|
@@ -2116,10 +2674,11 @@ export declare class IdentityClient {
|
|
|
2116
2674
|
* <p>
|
|
2117
2675
|
Updates the specified Swift password's description.
|
|
2118
2676
|
*
|
|
2677
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2119
2678
|
* @param UpdateSwiftPasswordRequest
|
|
2120
2679
|
* @return UpdateSwiftPasswordResponse
|
|
2121
2680
|
* @throws OciError when an error occurs
|
|
2122
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2681
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateSwiftPassword.ts.html |here} to see how to use UpdateSwiftPassword API.
|
|
2123
2682
|
*/
|
|
2124
2683
|
updateSwiftPassword(updateSwiftPasswordRequest: requests.UpdateSwiftPasswordRequest): Promise<responses.UpdateSwiftPasswordResponse>;
|
|
2125
2684
|
/**
|
|
@@ -2134,10 +2693,11 @@ export declare class IdentityClient {
|
|
|
2134
2693
|
You cannot remove list values that appear in a TagDefault. To remove a list value that
|
|
2135
2694
|
* appears in a TagDefault, first update the TagDefault to use a different value.
|
|
2136
2695
|
*
|
|
2696
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2137
2697
|
* @param UpdateTagRequest
|
|
2138
2698
|
* @return UpdateTagResponse
|
|
2139
2699
|
* @throws OciError when an error occurs
|
|
2140
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2700
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateTag.ts.html |here} to see how to use UpdateTag API.
|
|
2141
2701
|
*/
|
|
2142
2702
|
updateTag(updateTagRequest: requests.UpdateTagRequest): Promise<responses.UpdateTagResponse>;
|
|
2143
2703
|
/**
|
|
@@ -2148,10 +2708,11 @@ export declare class IdentityClient {
|
|
|
2148
2708
|
* If the `isRequired` flag is set to \"true\", the value is set during resource creation.
|
|
2149
2709
|
* * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
|
|
2150
2710
|
*
|
|
2711
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2151
2712
|
* @param UpdateTagDefaultRequest
|
|
2152
2713
|
* @return UpdateTagDefaultResponse
|
|
2153
2714
|
* @throws OciError when an error occurs
|
|
2154
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2715
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateTagDefault.ts.html |here} to see how to use UpdateTagDefault API.
|
|
2155
2716
|
*/
|
|
2156
2717
|
updateTagDefault(updateTagDefaultRequest: requests.UpdateTagDefaultRequest): Promise<responses.UpdateTagDefaultResponse>;
|
|
2157
2718
|
/**
|
|
@@ -2165,36 +2726,40 @@ export declare class IdentityClient {
|
|
|
2165
2726
|
* <p>
|
|
2166
2727
|
You can't add a namespace with the same name as a retired namespace in the same tenancy.
|
|
2167
2728
|
*
|
|
2729
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2168
2730
|
* @param UpdateTagNamespaceRequest
|
|
2169
2731
|
* @return UpdateTagNamespaceResponse
|
|
2170
2732
|
* @throws OciError when an error occurs
|
|
2171
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2733
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateTagNamespace.ts.html |here} to see how to use UpdateTagNamespace API.
|
|
2172
2734
|
*/
|
|
2173
2735
|
updateTagNamespace(updateTagNamespaceRequest: requests.UpdateTagNamespaceRequest): Promise<responses.UpdateTagNamespaceResponse>;
|
|
2174
2736
|
/**
|
|
2175
2737
|
* Updates the description of the specified user.
|
|
2738
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2176
2739
|
* @param UpdateUserRequest
|
|
2177
2740
|
* @return UpdateUserResponse
|
|
2178
2741
|
* @throws OciError when an error occurs
|
|
2179
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2742
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateUser.ts.html |here} to see how to use UpdateUser API.
|
|
2180
2743
|
*/
|
|
2181
2744
|
updateUser(updateUserRequest: requests.UpdateUserRequest): Promise<responses.UpdateUserResponse>;
|
|
2182
2745
|
/**
|
|
2183
2746
|
* Updates the capabilities of the specified user.
|
|
2184
2747
|
*
|
|
2748
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2185
2749
|
* @param UpdateUserCapabilitiesRequest
|
|
2186
2750
|
* @return UpdateUserCapabilitiesResponse
|
|
2187
2751
|
* @throws OciError when an error occurs
|
|
2188
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2752
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateUserCapabilities.ts.html |here} to see how to use UpdateUserCapabilities API.
|
|
2189
2753
|
*/
|
|
2190
2754
|
updateUserCapabilities(updateUserCapabilitiesRequest: requests.UpdateUserCapabilitiesRequest): Promise<responses.UpdateUserCapabilitiesResponse>;
|
|
2191
2755
|
/**
|
|
2192
2756
|
* Updates the state of the specified user.
|
|
2193
2757
|
*
|
|
2758
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2194
2759
|
* @param UpdateUserStateRequest
|
|
2195
2760
|
* @return UpdateUserStateResponse
|
|
2196
2761
|
* @throws OciError when an error occurs
|
|
2197
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2762
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UpdateUserState.ts.html |here} to see how to use UpdateUserState API.
|
|
2198
2763
|
*/
|
|
2199
2764
|
updateUserState(updateUserStateRequest: requests.UpdateUserStateRequest): Promise<responses.UpdateUserStateResponse>;
|
|
2200
2765
|
/**
|
|
@@ -2214,10 +2779,11 @@ export declare class IdentityClient {
|
|
|
2214
2779
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using
|
|
2215
2780
|
* the object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
2216
2781
|
*
|
|
2782
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
2217
2783
|
* @param UploadApiKeyRequest
|
|
2218
2784
|
* @return UploadApiKeyResponse
|
|
2219
2785
|
* @throws OciError when an error occurs
|
|
2220
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2786
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.1/identity/UploadApiKey.ts.html |here} to see how to use UploadApiKey API.
|
|
2221
2787
|
*/
|
|
2222
2788
|
uploadApiKey(uploadApiKeyRequest: requests.UploadApiKeyRequest): Promise<responses.UploadApiKeyResponse>;
|
|
2223
2789
|
}
|