oci-identity 2.20.0 → 2.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/client.d.ts +402 -481
- package/lib/client.js +541 -616
- package/lib/client.js.map +1 -1
- package/lib/identity-waiter.d.ts +1 -1
- package/lib/identity-waiter.js +1 -1
- package/lib/model/add-user-to-group-details.d.ts +1 -1
- package/lib/model/add-user-to-group-details.js +1 -1
- package/lib/model/allowed-domain-license-type-summary.d.ts +2 -2
- package/lib/model/allowed-domain-license-type-summary.js +1 -1
- package/lib/model/api-key.d.ts +1 -1
- package/lib/model/api-key.js +1 -1
- package/lib/model/auth-token.d.ts +7 -4
- package/lib/model/auth-token.js +1 -1
- package/lib/model/auth-token.js.map +1 -1
- package/lib/model/authentication-policy.d.ts +2 -2
- package/lib/model/authentication-policy.js +1 -1
- package/lib/model/availability-domain.d.ts +1 -1
- package/lib/model/availability-domain.js +1 -1
- package/lib/model/base-tag-definition-validator.d.ts +2 -2
- package/lib/model/base-tag-definition-validator.js +1 -1
- package/lib/model/bulk-action-resource-type-collection.d.ts +1 -1
- package/lib/model/bulk-action-resource-type-collection.js +1 -1
- package/lib/model/bulk-action-resource-type.d.ts +1 -1
- package/lib/model/bulk-action-resource-type.js +1 -1
- package/lib/model/bulk-action-resource.d.ts +1 -1
- package/lib/model/bulk-action-resource.js +1 -1
- package/lib/model/bulk-delete-resources-details.d.ts +1 -1
- package/lib/model/bulk-delete-resources-details.js +1 -1
- package/lib/model/bulk-delete-tags-details.d.ts +1 -1
- package/lib/model/bulk-delete-tags-details.js +1 -1
- package/lib/model/bulk-edit-operation-details.d.ts +1 -1
- package/lib/model/bulk-edit-operation-details.js +1 -1
- package/lib/model/bulk-edit-resource.d.ts +1 -1
- package/lib/model/bulk-edit-resource.js +1 -1
- package/lib/model/bulk-edit-tags-details.d.ts +1 -1
- package/lib/model/bulk-edit-tags-details.js +1 -1
- package/lib/model/bulk-edit-tags-resource-type-collection.d.ts +1 -1
- package/lib/model/bulk-edit-tags-resource-type-collection.js +1 -1
- package/lib/model/bulk-edit-tags-resource-type.d.ts +1 -1
- package/lib/model/bulk-edit-tags-resource-type.js +1 -1
- package/lib/model/bulk-move-resources-details.d.ts +1 -1
- package/lib/model/bulk-move-resources-details.js +1 -1
- package/lib/model/change-domain-compartment-details.d.ts +2 -2
- package/lib/model/change-domain-compartment-details.js +1 -1
- package/lib/model/change-domain-license-type-details.d.ts +3 -3
- package/lib/model/change-domain-license-type-details.js +1 -1
- package/lib/model/change-tag-namespace-compartment-detail.d.ts +1 -1
- package/lib/model/change-tag-namespace-compartment-detail.js +1 -1
- package/lib/model/change-tas-domain-license-type-details.d.ts +3 -3
- package/lib/model/change-tas-domain-license-type-details.js +1 -1
- package/lib/model/compartment.d.ts +3 -3
- package/lib/model/compartment.js +1 -1
- package/lib/model/create-api-key-details.d.ts +1 -1
- package/lib/model/create-api-key-details.js +1 -1
- package/lib/model/create-auth-token-details.d.ts +6 -4
- package/lib/model/create-auth-token-details.js +1 -1
- package/lib/model/create-auth-token-details.js.map +1 -1
- package/lib/model/create-compartment-details.d.ts +1 -1
- package/lib/model/create-compartment-details.js +1 -1
- package/lib/model/create-customer-secret-key-details.d.ts +1 -1
- package/lib/model/create-customer-secret-key-details.js +1 -1
- package/lib/model/create-db-credential-details.d.ts +6 -4
- package/lib/model/create-db-credential-details.js +1 -1
- package/lib/model/create-db-credential-details.js.map +1 -1
- package/lib/model/create-domain-details.d.ts +14 -16
- package/lib/model/create-domain-details.js +1 -1
- package/lib/model/create-domain-details.js.map +1 -1
- package/lib/model/create-dynamic-group-details.d.ts +7 -4
- package/lib/model/create-dynamic-group-details.js +1 -1
- package/lib/model/create-dynamic-group-details.js.map +1 -1
- package/lib/model/create-group-details.d.ts +6 -3
- package/lib/model/create-group-details.js +1 -1
- package/lib/model/create-group-details.js.map +1 -1
- package/lib/model/create-identity-provider-details.d.ts +1 -1
- package/lib/model/create-identity-provider-details.js +1 -1
- package/lib/model/create-idp-group-mapping-details.d.ts +1 -1
- package/lib/model/create-idp-group-mapping-details.js +1 -1
- package/lib/model/create-network-source-details.d.ts +2 -1
- package/lib/model/create-network-source-details.js +1 -1
- package/lib/model/create-network-source-details.js.map +1 -1
- package/lib/model/create-oauth2-client-credential-details.d.ts +1 -1
- package/lib/model/create-oauth2-client-credential-details.js +1 -1
- package/lib/model/create-policy-details.d.ts +3 -3
- package/lib/model/create-policy-details.js +1 -1
- package/lib/model/create-region-subscription-details.d.ts +1 -1
- package/lib/model/create-region-subscription-details.js +1 -1
- package/lib/model/create-saml2-identity-provider-details.d.ts +1 -1
- package/lib/model/create-saml2-identity-provider-details.js +1 -1
- package/lib/model/create-smtp-credential-details.d.ts +6 -4
- package/lib/model/create-smtp-credential-details.js +1 -1
- package/lib/model/create-smtp-credential-details.js.map +1 -1
- package/lib/model/create-swift-password-details.d.ts +6 -4
- package/lib/model/create-swift-password-details.js +1 -1
- package/lib/model/create-swift-password-details.js.map +1 -1
- package/lib/model/create-tag-default-details.d.ts +1 -1
- package/lib/model/create-tag-default-details.js +1 -1
- package/lib/model/create-tag-details.d.ts +1 -1
- package/lib/model/create-tag-details.js +1 -1
- package/lib/model/create-tag-namespace-details.d.ts +1 -1
- package/lib/model/create-tag-namespace-details.js +1 -1
- package/lib/model/create-user-details.d.ts +11 -5
- package/lib/model/create-user-details.js +1 -1
- package/lib/model/create-user-details.js.map +1 -1
- package/lib/model/customer-secret-key-summary.d.ts +1 -1
- package/lib/model/customer-secret-key-summary.js +1 -1
- package/lib/model/customer-secret-key.d.ts +2 -2
- package/lib/model/customer-secret-key.js +1 -1
- package/lib/model/db-credential-summary.d.ts +6 -3
- package/lib/model/db-credential-summary.js +1 -1
- package/lib/model/db-credential-summary.js.map +1 -1
- package/lib/model/db-credential.d.ts +1 -1
- package/lib/model/db-credential.js +1 -1
- package/lib/model/default-tag-definition-validator.d.ts +1 -1
- package/lib/model/default-tag-definition-validator.js +1 -1
- package/lib/model/domain-replication-states.d.ts +5 -5
- package/lib/model/domain-replication-states.js +1 -1
- package/lib/model/domain-replication.d.ts +5 -5
- package/lib/model/domain-replication.js +1 -1
- package/lib/model/domain-summary.d.ts +15 -15
- package/lib/model/domain-summary.js +1 -1
- package/lib/model/domain.d.ts +15 -14
- package/lib/model/domain.js +1 -1
- package/lib/model/domain.js.map +1 -1
- package/lib/model/dynamic-group.d.ts +8 -5
- package/lib/model/dynamic-group.js +1 -1
- package/lib/model/dynamic-group.js.map +1 -1
- package/lib/model/enable-replication-to-region-details.d.ts +3 -3
- package/lib/model/enable-replication-to-region-details.js +1 -1
- package/lib/model/enum-tag-definition-validator.d.ts +1 -1
- package/lib/model/enum-tag-definition-validator.js +1 -1
- package/lib/model/fault-domain.d.ts +1 -1
- package/lib/model/fault-domain.js +1 -1
- package/lib/model/fully-qualified-scope.d.ts +1 -1
- package/lib/model/fully-qualified-scope.js +1 -1
- package/lib/model/group.d.ts +8 -5
- package/lib/model/group.js +1 -1
- package/lib/model/group.js.map +1 -1
- package/lib/model/iam-work-request-error-summary.d.ts +3 -2
- package/lib/model/iam-work-request-error-summary.js +1 -1
- package/lib/model/iam-work-request-error-summary.js.map +1 -1
- package/lib/model/iam-work-request-log-summary.d.ts +2 -2
- package/lib/model/iam-work-request-log-summary.js +1 -1
- package/lib/model/iam-work-request-resource.d.ts +2 -2
- package/lib/model/iam-work-request-resource.js +1 -1
- package/lib/model/iam-work-request-summary.d.ts +3 -3
- package/lib/model/iam-work-request-summary.js +1 -1
- package/lib/model/iam-work-request.d.ts +4 -3
- package/lib/model/iam-work-request.js +1 -1
- package/lib/model/iam-work-request.js.map +1 -1
- package/lib/model/identity-provider-group-summary.d.ts +1 -1
- package/lib/model/identity-provider-group-summary.js +1 -1
- package/lib/model/identity-provider.d.ts +2 -2
- package/lib/model/identity-provider.js +1 -1
- package/lib/model/idp-group-mapping.d.ts +1 -1
- package/lib/model/idp-group-mapping.js +1 -1
- package/lib/model/import-standard-tags-details.d.ts +1 -1
- package/lib/model/import-standard-tags-details.js +1 -1
- package/lib/model/index.d.ts +1 -1
- package/lib/model/index.js +1 -1
- package/lib/model/mfa-totp-device-summary.d.ts +1 -1
- package/lib/model/mfa-totp-device-summary.js +1 -1
- package/lib/model/mfa-totp-device.d.ts +2 -2
- package/lib/model/mfa-totp-device.js +1 -1
- package/lib/model/mfa-totp-token.d.ts +1 -1
- package/lib/model/mfa-totp-token.js +1 -1
- package/lib/model/move-compartment-details.d.ts +1 -1
- package/lib/model/move-compartment-details.js +1 -1
- package/lib/model/network-policy.d.ts +2 -2
- package/lib/model/network-policy.js +1 -1
- package/lib/model/network-sources-summary.d.ts +1 -1
- package/lib/model/network-sources-summary.js +1 -1
- package/lib/model/network-sources.d.ts +1 -1
- package/lib/model/network-sources.js +1 -1
- package/lib/model/network-sources_virtual-source-list.d.ts +1 -1
- package/lib/model/network-sources_virtual-source-list.js +1 -1
- package/lib/model/o-auth2-client-credential-summary.d.ts +1 -1
- package/lib/model/o-auth2-client-credential-summary.js +1 -1
- package/lib/model/o-auth2-client-credential.d.ts +1 -1
- package/lib/model/o-auth2-client-credential.js +1 -1
- package/lib/model/password-policy.d.ts +1 -1
- package/lib/model/password-policy.js +1 -1
- package/lib/model/policy.d.ts +3 -3
- package/lib/model/policy.js +1 -1
- package/lib/model/region-subscription.d.ts +3 -3
- package/lib/model/region-subscription.js +1 -1
- package/lib/model/region.d.ts +2 -2
- package/lib/model/region.js +1 -1
- package/lib/model/replicated-region-details.d.ts +4 -4
- package/lib/model/replicated-region-details.js +1 -1
- package/lib/model/saml2-identity-provider.d.ts +1 -1
- package/lib/model/saml2-identity-provider.js +1 -1
- package/lib/model/scim-client-credentials.d.ts +1 -1
- package/lib/model/scim-client-credentials.js +1 -1
- package/lib/model/smtp-credential-summary.d.ts +6 -3
- package/lib/model/smtp-credential-summary.js +1 -1
- package/lib/model/smtp-credential-summary.js.map +1 -1
- package/lib/model/smtp-credential.d.ts +7 -4
- package/lib/model/smtp-credential.js +1 -1
- package/lib/model/smtp-credential.js.map +1 -1
- package/lib/model/standard-tag-definition-template.d.ts +1 -1
- package/lib/model/standard-tag-definition-template.js +1 -1
- package/lib/model/standard-tag-namespace-template-summary.d.ts +1 -1
- package/lib/model/standard-tag-namespace-template-summary.js +1 -1
- package/lib/model/standard-tag-namespace-template.d.ts +1 -1
- package/lib/model/standard-tag-namespace-template.js +1 -1
- package/lib/model/swift-password.d.ts +1 -1
- package/lib/model/swift-password.js +1 -1
- package/lib/model/tag-default-summary.d.ts +1 -1
- package/lib/model/tag-default-summary.js +1 -1
- package/lib/model/tag-default.d.ts +2 -2
- package/lib/model/tag-default.js +1 -1
- package/lib/model/tag-namespace-summary.d.ts +2 -2
- package/lib/model/tag-namespace-summary.js +1 -1
- package/lib/model/tag-namespace.d.ts +3 -3
- package/lib/model/tag-namespace.js +1 -1
- package/lib/model/tag-summary.d.ts +2 -2
- package/lib/model/tag-summary.js +1 -1
- package/lib/model/tag.d.ts +2 -2
- package/lib/model/tag.js +1 -1
- package/lib/model/tagging-work-request-error-summary.d.ts +1 -1
- package/lib/model/tagging-work-request-error-summary.js +1 -1
- package/lib/model/tagging-work-request-log-summary.d.ts +1 -1
- package/lib/model/tagging-work-request-log-summary.js +1 -1
- package/lib/model/tagging-work-request-summary.d.ts +1 -1
- package/lib/model/tagging-work-request-summary.js +1 -1
- package/lib/model/tagging-work-request.d.ts +1 -1
- package/lib/model/tagging-work-request.js +1 -1
- package/lib/model/tenancy.d.ts +2 -2
- package/lib/model/tenancy.js +1 -1
- package/lib/model/u-ipassword-information.d.ts +1 -1
- package/lib/model/u-ipassword-information.js +1 -1
- package/lib/model/u-ipassword.d.ts +2 -2
- package/lib/model/u-ipassword.js +1 -1
- package/lib/model/update-auth-token-details.d.ts +6 -3
- package/lib/model/update-auth-token-details.js +1 -1
- package/lib/model/update-auth-token-details.js.map +1 -1
- package/lib/model/update-authentication-policy-details.d.ts +1 -1
- package/lib/model/update-authentication-policy-details.js +1 -1
- package/lib/model/update-compartment-details.d.ts +1 -1
- package/lib/model/update-compartment-details.js +1 -1
- package/lib/model/update-customer-secret-key-details.d.ts +6 -3
- package/lib/model/update-customer-secret-key-details.js +1 -1
- package/lib/model/update-customer-secret-key-details.js.map +1 -1
- package/lib/model/update-domain-details.d.ts +5 -5
- package/lib/model/update-domain-details.js +1 -1
- package/lib/model/update-dynamic-group-details.d.ts +7 -4
- package/lib/model/update-dynamic-group-details.js +1 -1
- package/lib/model/update-dynamic-group-details.js.map +1 -1
- package/lib/model/update-group-details.d.ts +6 -3
- package/lib/model/update-group-details.js +1 -1
- package/lib/model/update-group-details.js.map +1 -1
- package/lib/model/update-identity-provider-details.d.ts +1 -1
- package/lib/model/update-identity-provider-details.js +1 -1
- package/lib/model/update-idp-group-mapping-details.d.ts +1 -1
- package/lib/model/update-idp-group-mapping-details.js +1 -1
- package/lib/model/update-network-source-details.d.ts +1 -1
- package/lib/model/update-network-source-details.js +1 -1
- package/lib/model/update-oauth2-client-credential-details.d.ts +1 -1
- package/lib/model/update-oauth2-client-credential-details.js +1 -1
- package/lib/model/update-policy-details.d.ts +3 -3
- package/lib/model/update-policy-details.js +1 -1
- package/lib/model/update-saml2-identity-provider-details.d.ts +1 -1
- package/lib/model/update-saml2-identity-provider-details.js +1 -1
- package/lib/model/update-smtp-credential-details.d.ts +6 -3
- package/lib/model/update-smtp-credential-details.js +1 -1
- package/lib/model/update-smtp-credential-details.js.map +1 -1
- package/lib/model/update-state-details.d.ts +1 -1
- package/lib/model/update-state-details.js +1 -1
- package/lib/model/update-swift-password-details.d.ts +6 -3
- package/lib/model/update-swift-password-details.js +1 -1
- package/lib/model/update-swift-password-details.js.map +1 -1
- package/lib/model/update-tag-default-details.d.ts +1 -1
- package/lib/model/update-tag-default-details.js +1 -1
- package/lib/model/update-tag-details.d.ts +2 -2
- package/lib/model/update-tag-details.js +1 -1
- package/lib/model/update-tag-namespace-details.d.ts +2 -2
- package/lib/model/update-tag-namespace-details.js +1 -1
- package/lib/model/update-user-capabilities-details.d.ts +1 -1
- package/lib/model/update-user-capabilities-details.js +1 -1
- package/lib/model/update-user-details.d.ts +11 -5
- package/lib/model/update-user-details.js +1 -1
- package/lib/model/update-user-details.js.map +1 -1
- package/lib/model/user-capabilities.d.ts +1 -1
- package/lib/model/user-capabilities.js +1 -1
- package/lib/model/user-group-membership.d.ts +1 -1
- package/lib/model/user-group-membership.js +1 -1
- package/lib/model/user.d.ts +16 -11
- package/lib/model/user.js +1 -1
- package/lib/model/user.js.map +1 -1
- package/lib/model/work-request-error.d.ts +1 -1
- package/lib/model/work-request-error.js +1 -1
- package/lib/model/work-request-log-entry.d.ts +1 -1
- package/lib/model/work-request-log-entry.js +1 -1
- package/lib/model/work-request-resource.d.ts +1 -1
- package/lib/model/work-request-resource.js +1 -1
- package/lib/model/work-request-summary.d.ts +1 -1
- package/lib/model/work-request-summary.js +1 -1
- package/lib/model/work-request.d.ts +1 -1
- package/lib/model/work-request.js +1 -1
- package/lib/request/activate-domain-request.d.ts +2 -2
- 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 +3 -3
- package/lib/request/change-domain-license-type-request.d.ts +3 -3
- 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-db-credential-request.d.ts +1 -1
- package/lib/request/create-domain-request.d.ts +2 -2
- 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 +2 -2
- 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 +2 -2
- package/lib/request/delete-db-credential-request.d.ts +1 -1
- package/lib/request/delete-domain-request.d.ts +2 -2
- 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 +3 -3
- 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 +2 -2
- 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 +1 -1
- package/lib/request/get-identity-provider-request.d.ts +1 -1
- package/lib/request/get-idp-group-mapping-request.d.ts +1 -1
- package/lib/request/get-mfa-totp-device-request.d.ts +1 -1
- package/lib/request/get-network-source-request.d.ts +1 -1
- package/lib/request/get-policy-request.d.ts +1 -1
- package/lib/request/get-standard-tag-template-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/import-standard-tags-request.d.ts +1 -1
- package/lib/request/index.d.ts +1 -1
- package/lib/request/index.js +1 -1
- package/lib/request/list-allowed-domain-license-types-request.d.ts +2 -2
- 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-db-credentials-request.d.ts +1 -1
- package/lib/request/list-domains-request.d.ts +8 -8
- package/lib/request/list-dynamic-groups-request.d.ts +1 -1
- package/lib/request/list-fault-domains-request.d.ts +2 -2
- package/lib/request/list-groups-request.d.ts +1 -1
- package/lib/request/list-iam-work-request-errors-request.d.ts +1 -1
- package/lib/request/list-iam-work-request-logs-request.d.ts +1 -1
- package/lib/request/list-iam-work-requests-request.d.ts +1 -1
- package/lib/request/list-identity-provider-groups-request.d.ts +1 -1
- package/lib/request/list-identity-providers-request.d.ts +1 -1
- package/lib/request/list-idp-group-mappings-request.d.ts +1 -1
- package/lib/request/list-mfa-totp-devices-request.d.ts +1 -1
- package/lib/request/list-network-sources-request.d.ts +1 -1
- package/lib/request/list-oauth-client-credentials-request.d.ts +1 -1
- package/lib/request/list-policies-request.d.ts +1 -1
- package/lib/request/list-region-subscriptions-request.d.ts +1 -1
- package/lib/request/list-regions-request.d.ts +1 -1
- package/lib/request/list-smtp-credentials-request.d.ts +1 -1
- package/lib/request/list-standard-tag-namespaces-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 +2 -2
- package/lib/request/update-domain-request.d.ts +3 -3
- 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/index.d.ts +1 -1
- package/lib/response/index.js +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Identity and Access Management Service API
|
|
3
|
-
* APIs for managing users, groups, compartments, and
|
|
3
|
+
* APIs for managing users, groups, compartments, policies, and identity domains.
|
|
4
4
|
* OpenAPI spec version: 20160918
|
|
5
5
|
*
|
|
6
6
|
*
|
|
@@ -28,6 +28,7 @@ export declare class IdentityClient {
|
|
|
28
28
|
protected "_waiters": IdentityWaiter;
|
|
29
29
|
protected "_clientConfiguration": common.ClientConfiguration;
|
|
30
30
|
protected _circuitBreaker: null;
|
|
31
|
+
protected _httpOptions: any;
|
|
31
32
|
protected _httpClient: common.HttpClient;
|
|
32
33
|
constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
|
|
33
34
|
/**
|
|
@@ -69,39 +70,29 @@ export declare class IdentityClient {
|
|
|
69
70
|
*/
|
|
70
71
|
getWaiters(): IdentityWaiter;
|
|
71
72
|
/**
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
* the async operation's status. Deactivate a domain can be done using HTTP POST
|
|
80
|
-
* /domains/{domainId}/actions/deactivate.
|
|
81
|
-
* <p>
|
|
82
|
-
- If the domain's {@code lifecycleState} is ACTIVE, returns 202 ACCEPTED with no action
|
|
83
|
-
* taken on service side.
|
|
84
|
-
* - If domain is of {@code type} DEFAULT or DEFAULT_LIGHTWEIGHT or domain's {@code lifecycleState} is not INACTIVE,
|
|
85
|
-
* returns 400 BAD REQUEST.
|
|
86
|
-
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
87
|
-
* - If the authenticated user is part of the domain to be activated, returns 400 BAD REQUEST
|
|
88
|
-
* - If error occurs while activating domain, returns 500 INTERNAL SERVER ERROR.
|
|
73
|
+
* (For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of.
|
|
74
|
+
* <p>
|
|
75
|
+
After you send the request, the `lifecycleDetails` of the identity domain is set to ACTIVATING. When the operation completes, the
|
|
76
|
+
* `lifecycleDetails` is set to null and the `lifecycleState` of the identity domain is set to ACTIVE.
|
|
77
|
+
* <p>
|
|
78
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
79
|
+
* the operation's status.
|
|
89
80
|
*
|
|
90
|
-
* This operation
|
|
81
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
91
82
|
* @param ActivateDomainRequest
|
|
92
83
|
* @return ActivateDomainResponse
|
|
93
84
|
* @throws OciError when an error occurs
|
|
94
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
85
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ActivateDomain.ts.html |here} to see how to use ActivateDomain API.
|
|
95
86
|
*/
|
|
96
87
|
activateDomain(activateDomainRequest: requests.ActivateDomainRequest): Promise<responses.ActivateDomainResponse>;
|
|
97
88
|
/**
|
|
98
89
|
* Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.
|
|
99
90
|
*
|
|
100
|
-
* This operation
|
|
91
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
101
92
|
* @param ActivateMfaTotpDeviceRequest
|
|
102
93
|
* @return ActivateMfaTotpDeviceResponse
|
|
103
94
|
* @throws OciError when an error occurs
|
|
104
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
95
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ActivateMfaTotpDevice.ts.html |here} to see how to use ActivateMfaTotpDevice API.
|
|
105
96
|
*/
|
|
106
97
|
activateMfaTotpDevice(activateMfaTotpDeviceRequest: requests.ActivateMfaTotpDeviceRequest): Promise<responses.ActivateMfaTotpDeviceResponse>;
|
|
107
98
|
/**
|
|
@@ -110,11 +101,11 @@ export declare class IdentityClient {
|
|
|
110
101
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
111
102
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
112
103
|
*
|
|
113
|
-
* This operation
|
|
104
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
114
105
|
* @param AddUserToGroupRequest
|
|
115
106
|
* @return AddUserToGroupResponse
|
|
116
107
|
* @throws OciError when an error occurs
|
|
117
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
108
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/AddUserToGroup.ts.html |here} to see how to use AddUserToGroup API.
|
|
118
109
|
*/
|
|
119
110
|
addUserToGroup(addUserToGroupRequest: requests.AddUserToGroupRequest): Promise<responses.AddUserToGroupResponse>;
|
|
120
111
|
/**
|
|
@@ -123,25 +114,25 @@ export declare class IdentityClient {
|
|
|
123
114
|
* referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults
|
|
124
115
|
* includes all tag defaults from the current compartment back to the root compartment.
|
|
125
116
|
*
|
|
126
|
-
* This operation
|
|
117
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
127
118
|
* @param AssembleEffectiveTagSetRequest
|
|
128
119
|
* @return AssembleEffectiveTagSetResponse
|
|
129
120
|
* @throws OciError when an error occurs
|
|
130
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
121
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/AssembleEffectiveTagSet.ts.html |here} to see how to use AssembleEffectiveTagSet API.
|
|
131
122
|
*/
|
|
132
123
|
assembleEffectiveTagSet(assembleEffectiveTagSetRequest: requests.AssembleEffectiveTagSetRequest): Promise<responses.AssembleEffectiveTagSetResponse>;
|
|
133
124
|
/**
|
|
134
125
|
* Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate
|
|
135
126
|
* permissions to delete the resources in the request. This API can only be invoked from the tenancy's
|
|
136
|
-
* [home region](https://docs.cloud.oracle.com/Content/Identity/
|
|
127
|
+
* [home region](https://docs.cloud.oracle.com/Content/Identity/regions/managingregions.htm#Home). This operation creates a
|
|
137
128
|
* {@link WorkRequest}. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest}
|
|
138
129
|
* API to monitor the status of the bulk action.
|
|
139
130
|
*
|
|
140
|
-
* This operation
|
|
131
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
141
132
|
* @param BulkDeleteResourcesRequest
|
|
142
133
|
* @return BulkDeleteResourcesResponse
|
|
143
134
|
* @throws OciError when an error occurs
|
|
144
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
135
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/BulkDeleteResources.ts.html |here} to see how to use BulkDeleteResources API.
|
|
145
136
|
*/
|
|
146
137
|
bulkDeleteResources(bulkDeleteResourcesRequest: requests.BulkDeleteResourcesRequest): Promise<responses.BulkDeleteResourcesResponse>;
|
|
147
138
|
/**
|
|
@@ -167,11 +158,11 @@ export declare class IdentityClient {
|
|
|
167
158
|
In order to delete tags, you must first retire the tags. Use {@link #updateTag(UpdateTagRequest) updateTag}
|
|
168
159
|
* to retire a tag.
|
|
169
160
|
*
|
|
170
|
-
* This operation
|
|
161
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
171
162
|
* @param BulkDeleteTagsRequest
|
|
172
163
|
* @return BulkDeleteTagsResponse
|
|
173
164
|
* @throws OciError when an error occurs
|
|
174
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
165
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/BulkDeleteTags.ts.html |here} to see how to use BulkDeleteTags API.
|
|
175
166
|
*/
|
|
176
167
|
bulkDeleteTags(bulkDeleteTagsRequest: requests.BulkDeleteTagsRequest): Promise<responses.BulkDeleteTagsResponse>;
|
|
177
168
|
/**
|
|
@@ -190,25 +181,25 @@ export declare class IdentityClient {
|
|
|
190
181
|
* For example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`,
|
|
191
182
|
* `tag set-1` and `tag set-2` cannot have any common tag definitions.
|
|
192
183
|
*
|
|
193
|
-
* This operation
|
|
184
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
194
185
|
* @param BulkEditTagsRequest
|
|
195
186
|
* @return BulkEditTagsResponse
|
|
196
187
|
* @throws OciError when an error occurs
|
|
197
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
188
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/BulkEditTags.ts.html |here} to see how to use BulkEditTags API.
|
|
198
189
|
*/
|
|
199
190
|
bulkEditTags(bulkEditTagsRequest: requests.BulkEditTagsRequest): Promise<responses.BulkEditTagsResponse>;
|
|
200
191
|
/**
|
|
201
192
|
* Moves multiple resources from one compartment to another. All resources must be in the same compartment.
|
|
202
|
-
* This API can only be invoked from the tenancy's [home region](https://docs.cloud.oracle.com/Content/Identity/
|
|
193
|
+
* This API can only be invoked from the tenancy's [home region](https://docs.cloud.oracle.com/Content/Identity/regions/managingregions.htm#Home).
|
|
203
194
|
* To move resources, you must have the appropriate permissions to move the resource in both the source and target
|
|
204
195
|
* compartments. This operation creates a {@link WorkRequest}.
|
|
205
196
|
* Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.
|
|
206
197
|
*
|
|
207
|
-
* This operation
|
|
198
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
208
199
|
* @param BulkMoveResourcesRequest
|
|
209
200
|
* @return BulkMoveResourcesResponse
|
|
210
201
|
* @throws OciError when an error occurs
|
|
211
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
202
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/BulkMoveResources.ts.html |here} to see how to use BulkMoveResources API.
|
|
212
203
|
*/
|
|
213
204
|
bulkMoveResources(bulkMoveResourcesRequest: requests.BulkMoveResourcesRequest): Promise<responses.BulkMoveResourcesResponse>;
|
|
214
205
|
/**
|
|
@@ -232,76 +223,62 @@ export declare class IdentityClient {
|
|
|
232
223
|
To delete a tag namespace, you must first retire it. Use {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}
|
|
233
224
|
* to retire a tag namespace.
|
|
234
225
|
*
|
|
235
|
-
* This operation
|
|
226
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
236
227
|
* @param CascadeDeleteTagNamespaceRequest
|
|
237
228
|
* @return CascadeDeleteTagNamespaceResponse
|
|
238
229
|
* @throws OciError when an error occurs
|
|
239
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
230
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CascadeDeleteTagNamespace.ts.html |here} to see how to use CascadeDeleteTagNamespace API.
|
|
240
231
|
*/
|
|
241
232
|
cascadeDeleteTagNamespace(cascadeDeleteTagNamespaceRequest: requests.CascadeDeleteTagNamespaceRequest): Promise<responses.CascadeDeleteTagNamespaceResponse>;
|
|
242
233
|
/**
|
|
243
|
-
*
|
|
234
|
+
* (For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy.
|
|
244
235
|
* <p>
|
|
245
|
-
|
|
246
|
-
*
|
|
247
|
-
* the async operation's status.
|
|
248
|
-
* <p>
|
|
249
|
-
The compartment change is complete when accessed via domain URL and
|
|
250
|
-
* also returns new compartment OCID.
|
|
251
|
-
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
252
|
-
* - If Domain {@code type} is DEFAULT or DEFAULT_LIGHTWEIGHT, return 400 BAD Request
|
|
253
|
-
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
254
|
-
* - If error occurs while changing compartment for domain, return 500 INTERNAL SERVER ERROR.
|
|
236
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
237
|
+
* the operation's status.
|
|
255
238
|
*
|
|
256
|
-
* This operation
|
|
239
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
257
240
|
* @param ChangeDomainCompartmentRequest
|
|
258
241
|
* @return ChangeDomainCompartmentResponse
|
|
259
242
|
* @throws OciError when an error occurs
|
|
260
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
243
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ChangeDomainCompartment.ts.html |here} to see how to use ChangeDomainCompartment API.
|
|
261
244
|
*/
|
|
262
245
|
changeDomainCompartment(changeDomainCompartmentRequest: requests.ChangeDomainCompartmentRequest): Promise<responses.ChangeDomainCompartmentResponse>;
|
|
263
246
|
/**
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
|
|
272
|
-
*
|
|
273
|
-
- If license type update is successful, return 202 ACCEPTED
|
|
274
|
-
* - If requested {@code licenseType} validation fails, returns 400 Bad request.
|
|
275
|
-
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
276
|
-
* - If Domain {@code type} is DEFAULT or DEFAULT_LIGHTWEIGHT, return 400 BAD Request
|
|
277
|
-
* - If the domain doesn't exists, returns 404 NOT FOUND
|
|
278
|
-
* - If any internal error occurs, returns 500 INTERNAL SERVER ERROR.
|
|
247
|
+
* (For tenancies that support identity domains) Changes the license type of the given identity domain. The identity domain's
|
|
248
|
+
* `lifecycleState` must be set to ACTIVE and the requested `licenseType` must be allowed. To retrieve the allowed `licenseType` for
|
|
249
|
+
* the identity domain, use {@link #listAllowedDomainLicenseTypes(ListAllowedDomainLicenseTypesRequest) listAllowedDomainLicenseTypes}.
|
|
250
|
+
* <p>
|
|
251
|
+
After you send your request, the `lifecycleDetails` of this identity domain is set to UPDATING. When the update of the identity
|
|
252
|
+
* domain completes, then the `lifecycleDetails` is set to null.
|
|
253
|
+
* <p>
|
|
254
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
255
|
+
* the operation's status.
|
|
279
256
|
*
|
|
280
|
-
* This operation
|
|
257
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
281
258
|
* @param ChangeDomainLicenseTypeRequest
|
|
282
259
|
* @return ChangeDomainLicenseTypeResponse
|
|
283
260
|
* @throws OciError when an error occurs
|
|
284
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
261
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ChangeDomainLicenseType.ts.html |here} to see how to use ChangeDomainLicenseType API.
|
|
285
262
|
*/
|
|
286
263
|
changeDomainLicenseType(changeDomainLicenseTypeRequest: requests.ChangeDomainLicenseTypeRequest): Promise<responses.ChangeDomainLicenseTypeResponse>;
|
|
287
264
|
/**
|
|
288
265
|
* Moves the specified tag namespace to the specified compartment within the same tenancy.
|
|
289
266
|
* <p>
|
|
290
267
|
To move the tag namespace, you must have the manage tag-namespaces permission on both compartments.
|
|
291
|
-
* For more information about IAM policies, see [Details for IAM](https://docs.cloud.oracle.com/Content/Identity/
|
|
268
|
+
* For more information about IAM policies, see [Details for IAM](https://docs.cloud.oracle.com/Content/Identity/policyreference/iampolicyreference.htm).
|
|
292
269
|
* <p>
|
|
293
270
|
Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
|
|
294
271
|
*
|
|
295
|
-
* This operation
|
|
272
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
296
273
|
* @param ChangeTagNamespaceCompartmentRequest
|
|
297
274
|
* @return ChangeTagNamespaceCompartmentResponse
|
|
298
275
|
* @throws OciError when an error occurs
|
|
299
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
276
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ChangeTagNamespaceCompartment.ts.html |here} to see how to use ChangeTagNamespaceCompartment API.
|
|
300
277
|
*/
|
|
301
278
|
changeTagNamespaceCompartment(changeTagNamespaceCompartmentRequest: requests.ChangeTagNamespaceCompartmentRequest): Promise<responses.ChangeTagNamespaceCompartmentResponse>;
|
|
302
279
|
/**
|
|
303
280
|
* Creates a new auth token for the specified user. For information about what auth tokens are for, see
|
|
304
|
-
* [Managing User Credentials](https://docs.cloud.oracle.com/Content/Identity/
|
|
281
|
+
* [Managing User Credentials](https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).
|
|
305
282
|
* <p>
|
|
306
283
|
You must specify a *description* for the auth token (although it can be an empty string). It does not
|
|
307
284
|
* have to be unique, and you can change it anytime with
|
|
@@ -311,18 +288,16 @@ export declare class IdentityClient {
|
|
|
311
288
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
312
289
|
* tenancy can use this operation to create an auth token for any user, including themselves.
|
|
313
290
|
*
|
|
314
|
-
* This operation
|
|
291
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
315
292
|
* @param CreateAuthTokenRequest
|
|
316
293
|
* @return CreateAuthTokenResponse
|
|
317
294
|
* @throws OciError when an error occurs
|
|
318
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
295
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateAuthToken.ts.html |here} to see how to use CreateAuthToken API.
|
|
319
296
|
*/
|
|
320
297
|
createAuthToken(createAuthTokenRequest: requests.CreateAuthTokenRequest): Promise<responses.CreateAuthTokenResponse>;
|
|
321
298
|
/**
|
|
322
299
|
* Creates a new compartment in the specified compartment.
|
|
323
300
|
* <p>
|
|
324
|
-
**Important:** Compartments cannot be deleted.
|
|
325
|
-
* <p>
|
|
326
301
|
Specify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy
|
|
327
302
|
* is simply the root compartment. For information about OCIDs, see
|
|
328
303
|
* [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
|
|
@@ -330,7 +305,7 @@ export declare class IdentityClient {
|
|
|
330
305
|
You must also specify a *name* for the compartment, which must be unique across all compartments in
|
|
331
306
|
* your tenancy. You can use this name or the OCID when writing policies that apply
|
|
332
307
|
* to the compartment. For more information about policies, see
|
|
333
|
-
* [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/
|
|
308
|
+
* [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm).
|
|
334
309
|
* <p>
|
|
335
310
|
You must also specify a *description* for the compartment (although it can be an empty string). It does
|
|
336
311
|
* not have to be unique, and you can change it anytime with
|
|
@@ -339,17 +314,17 @@ export declare class IdentityClient {
|
|
|
339
314
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
340
315
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
341
316
|
*
|
|
342
|
-
* This operation
|
|
317
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
343
318
|
* @param CreateCompartmentRequest
|
|
344
319
|
* @return CreateCompartmentResponse
|
|
345
320
|
* @throws OciError when an error occurs
|
|
346
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
321
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateCompartment.ts.html |here} to see how to use CreateCompartment API.
|
|
347
322
|
*/
|
|
348
323
|
createCompartment(createCompartmentRequest: requests.CreateCompartmentRequest): Promise<responses.CreateCompartmentResponse>;
|
|
349
324
|
/**
|
|
350
325
|
* Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3
|
|
351
326
|
* compatible API. The secret key consists of an Access Key/Secret Key pair. For information, see
|
|
352
|
-
* [Managing User Credentials](https://docs.cloud.oracle.com/Content/Identity/
|
|
327
|
+
* [Managing User Credentials](https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).
|
|
353
328
|
* <p>
|
|
354
329
|
You must specify a *description* for the secret key (although it can be an empty string). It does not
|
|
355
330
|
* have to be unique, and you can change it anytime with
|
|
@@ -359,46 +334,38 @@ export declare class IdentityClient {
|
|
|
359
334
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
360
335
|
* tenancy can use this operation to create a secret key for any user, including themselves.
|
|
361
336
|
*
|
|
362
|
-
* This operation
|
|
337
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
363
338
|
* @param CreateCustomerSecretKeyRequest
|
|
364
339
|
* @return CreateCustomerSecretKeyResponse
|
|
365
340
|
* @throws OciError when an error occurs
|
|
366
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
341
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateCustomerSecretKey.ts.html |here} to see how to use CreateCustomerSecretKey API.
|
|
367
342
|
*/
|
|
368
343
|
createCustomerSecretKey(createCustomerSecretKeyRequest: requests.CreateCustomerSecretKeyRequest): Promise<responses.CreateCustomerSecretKeyResponse>;
|
|
369
344
|
/**
|
|
370
345
|
* Creates a new DB credential for the specified user.
|
|
371
346
|
*
|
|
372
|
-
* This operation
|
|
347
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
373
348
|
* @param CreateDbCredentialRequest
|
|
374
349
|
* @return CreateDbCredentialResponse
|
|
375
350
|
* @throws OciError when an error occurs
|
|
376
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
351
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateDbCredential.ts.html |here} to see how to use CreateDbCredential API.
|
|
377
352
|
*/
|
|
378
353
|
createDbCredential(createDbCredentialRequest: requests.CreateDbCredentialRequest): Promise<responses.CreateDbCredentialResponse>;
|
|
379
354
|
/**
|
|
380
|
-
* Creates a new domain in the tenancy with domain home in
|
|
381
|
-
*
|
|
382
|
-
* this
|
|
383
|
-
* <p>
|
|
384
|
-
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint
|
|
385
|
-
* the
|
|
386
|
-
* <p>
|
|
387
|
-
After creating
|
|
388
|
-
* before using it.
|
|
389
|
-
* If the domain's {@code displayName} already exists, returns 400 BAD REQUEST.
|
|
390
|
-
* If any one of admin related fields are provided and one of the following 3 fields
|
|
391
|
-
* - {@code adminEmail}, {@code adminLastName} and {@code adminUserName} - is not provided,
|
|
392
|
-
* returns 400 BAD REQUEST.
|
|
393
|
-
* - If {@code isNotificationBypassed} is NOT provided when admin information is provided,
|
|
394
|
-
* returns 400 BAD REQUEST.
|
|
395
|
-
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
355
|
+
* (For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in `homeRegion`.
|
|
356
|
+
* After you send your request, the temporary `lifecycleState` of this identity domain is set to CREATING and `lifecycleDetails` to UPDATING.
|
|
357
|
+
* When creation of the identity domain completes, this identity domain's `lifecycleState` is set to ACTIVE and `lifecycleDetails` to null.
|
|
358
|
+
* <p>
|
|
359
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
360
|
+
* the operation's status.
|
|
361
|
+
* <p>
|
|
362
|
+
After creating an `identity domain`, first make sure its `lifecycleState` changes from CREATING to ACTIVE before you use it.
|
|
396
363
|
*
|
|
397
|
-
* This operation
|
|
364
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
398
365
|
* @param CreateDomainRequest
|
|
399
366
|
* @return CreateDomainResponse
|
|
400
367
|
* @throws OciError when an error occurs
|
|
401
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
368
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateDomain.ts.html |here} to see how to use CreateDomain API.
|
|
402
369
|
*/
|
|
403
370
|
createDomain(createDomainRequest: requests.CreateDomainRequest): Promise<responses.CreateDomainResponse>;
|
|
404
371
|
/**
|
|
@@ -413,7 +380,7 @@ export declare class IdentityClient {
|
|
|
413
380
|
You must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your
|
|
414
381
|
* tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy.
|
|
415
382
|
* You can use this name or the OCID when writing policies that apply to the dynamic group. For more information
|
|
416
|
-
* about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/
|
|
383
|
+
* about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm).
|
|
417
384
|
* <p>
|
|
418
385
|
You must also specify a *description* for the dynamic group (although it can be an empty string). It does not
|
|
419
386
|
* have to be unique, and you can change it anytime with {@link #updateDynamicGroup(UpdateDynamicGroupRequest) updateDynamicGroup}.
|
|
@@ -421,11 +388,11 @@ export declare class IdentityClient {
|
|
|
421
388
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
422
389
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
423
390
|
*
|
|
424
|
-
* This operation
|
|
391
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
425
392
|
* @param CreateDynamicGroupRequest
|
|
426
393
|
* @return CreateDynamicGroupResponse
|
|
427
394
|
* @throws OciError when an error occurs
|
|
428
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
395
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateDynamicGroup.ts.html |here} to see how to use CreateDynamicGroup API.
|
|
429
396
|
*/
|
|
430
397
|
createDynamicGroup(createDynamicGroupRequest: requests.CreateDynamicGroupRequest): Promise<responses.CreateDynamicGroupResponse>;
|
|
431
398
|
/**
|
|
@@ -439,7 +406,7 @@ export declare class IdentityClient {
|
|
|
439
406
|
* <p>
|
|
440
407
|
You must also specify a *name* for the group, which must be unique across all groups in your tenancy and
|
|
441
408
|
* cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more
|
|
442
|
-
* information about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/
|
|
409
|
+
* information about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm).
|
|
443
410
|
* <p>
|
|
444
411
|
You must also specify a *description* for the group (although it can be an empty string). It does not
|
|
445
412
|
* have to be unique, and you can change it anytime with {@link #updateGroup(UpdateGroupRequest) updateGroup}.
|
|
@@ -451,11 +418,11 @@ export declare class IdentityClient {
|
|
|
451
418
|
* See {@link #addUserToGroup(AddUserToGroupRequest) addUserToGroup} and
|
|
452
419
|
* {@link #createPolicy(CreatePolicyRequest) createPolicy}.
|
|
453
420
|
*
|
|
454
|
-
* This operation
|
|
421
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
455
422
|
* @param CreateGroupRequest
|
|
456
423
|
* @return CreateGroupResponse
|
|
457
424
|
* @throws OciError when an error occurs
|
|
458
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
425
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateGroup.ts.html |here} to see how to use CreateGroup API.
|
|
459
426
|
*/
|
|
460
427
|
createGroup(createGroupRequest: requests.CreateGroupRequest): Promise<responses.CreateGroupResponse>;
|
|
461
428
|
/**
|
|
@@ -480,11 +447,11 @@ export declare class IdentityClient {
|
|
|
480
447
|
* be CREATING. Before using the object, first make sure its `lifecycleState` has
|
|
481
448
|
* changed to ACTIVE.
|
|
482
449
|
*
|
|
483
|
-
* This operation
|
|
450
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
484
451
|
* @param CreateIdentityProviderRequest
|
|
485
452
|
* @return CreateIdentityProviderResponse
|
|
486
453
|
* @throws OciError when an error occurs
|
|
487
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
454
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateIdentityProvider.ts.html |here} to see how to use CreateIdentityProvider API.
|
|
488
455
|
*/
|
|
489
456
|
createIdentityProvider(createIdentityProviderRequest: requests.CreateIdentityProviderRequest): Promise<responses.CreateIdentityProviderResponse>;
|
|
490
457
|
/**
|
|
@@ -493,21 +460,21 @@ export declare class IdentityClient {
|
|
|
493
460
|
Creates a single mapping between an IdP group and an IAM Service
|
|
494
461
|
* {@link Group}.
|
|
495
462
|
*
|
|
496
|
-
* This operation
|
|
463
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
497
464
|
* @param CreateIdpGroupMappingRequest
|
|
498
465
|
* @return CreateIdpGroupMappingResponse
|
|
499
466
|
* @throws OciError when an error occurs
|
|
500
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
467
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateIdpGroupMapping.ts.html |here} to see how to use CreateIdpGroupMapping API.
|
|
501
468
|
*/
|
|
502
469
|
createIdpGroupMapping(createIdpGroupMappingRequest: requests.CreateIdpGroupMappingRequest): Promise<responses.CreateIdpGroupMappingResponse>;
|
|
503
470
|
/**
|
|
504
471
|
* Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.
|
|
505
472
|
*
|
|
506
|
-
* This operation
|
|
473
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
507
474
|
* @param CreateMfaTotpDeviceRequest
|
|
508
475
|
* @return CreateMfaTotpDeviceResponse
|
|
509
476
|
* @throws OciError when an error occurs
|
|
510
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
477
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateMfaTotpDevice.ts.html |here} to see how to use CreateMfaTotpDevice API.
|
|
511
478
|
*/
|
|
512
479
|
createMfaTotpDevice(createMfaTotpDeviceRequest: requests.CreateMfaTotpDeviceRequest): Promise<responses.CreateMfaTotpDeviceResponse>;
|
|
513
480
|
/**
|
|
@@ -522,7 +489,7 @@ export declare class IdentityClient {
|
|
|
522
489
|
You must also specify a *name* for the network source, which must be unique across all network sources in your
|
|
523
490
|
* tenancy, and cannot be changed.
|
|
524
491
|
* You can use this name or the OCID when writing policies that apply to the network source. For more information
|
|
525
|
-
* about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/
|
|
492
|
+
* about policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm).
|
|
526
493
|
* <p>
|
|
527
494
|
You must also specify a *description* for the network source (although it can be an empty string). It does not
|
|
528
495
|
* have to be unique, and you can change it anytime with {@link #updateNetworkSource(UpdateNetworkSourceRequest) updateNetworkSource}.
|
|
@@ -533,26 +500,26 @@ export declare class IdentityClient {
|
|
|
533
500
|
After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed
|
|
534
501
|
* IP address specified in your network source. For more information, see [Managing Network Sources](https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).
|
|
535
502
|
*
|
|
536
|
-
* This operation
|
|
503
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
537
504
|
* @param CreateNetworkSourceRequest
|
|
538
505
|
* @return CreateNetworkSourceResponse
|
|
539
506
|
* @throws OciError when an error occurs
|
|
540
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
507
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateNetworkSource.ts.html |here} to see how to use CreateNetworkSource API.
|
|
541
508
|
*/
|
|
542
509
|
createNetworkSource(createNetworkSourceRequest: requests.CreateNetworkSourceRequest): Promise<responses.CreateNetworkSourceResponse>;
|
|
543
510
|
/**
|
|
544
511
|
* Creates Oauth token for the user
|
|
545
512
|
*
|
|
546
|
-
* This operation
|
|
513
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
547
514
|
* @param CreateOAuthClientCredentialRequest
|
|
548
515
|
* @return CreateOAuthClientCredentialResponse
|
|
549
516
|
* @throws OciError when an error occurs
|
|
550
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
517
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateOAuthClientCredential.ts.html |here} to see how to use CreateOAuthClientCredential API.
|
|
551
518
|
*/
|
|
552
519
|
createOAuthClientCredential(createOAuthClientCredentialRequest: requests.CreateOAuthClientCredentialRequest): Promise<responses.CreateOAuthClientCredentialResponse>;
|
|
553
520
|
/**
|
|
554
521
|
* Creates a new Console one-time password for the specified user. For more information about user
|
|
555
|
-
* credentials, see [User Credentials](https://docs.cloud.oracle.com/Content/Identity/
|
|
522
|
+
* credentials, see [User Credentials](https://docs.cloud.oracle.com/Content/Identity/usercred/usercredentials.htm).
|
|
556
523
|
* <p>
|
|
557
524
|
Use this operation after creating a new user, or if a user forgets their password. The new one-time
|
|
558
525
|
* password is returned to you in the response, and you must securely deliver it to the user. They'll
|
|
@@ -560,19 +527,23 @@ export declare class IdentityClient {
|
|
|
560
527
|
* it within 7 days, the password will expire and you'll need to create a new one-time password for the
|
|
561
528
|
* user.
|
|
562
529
|
* <p>
|
|
530
|
+
(For tenancies that support identity domains) Resetting a user's password generates a reset password email
|
|
531
|
+
* with a link that the user must follow to reset their password. If the user does not reset their password before the
|
|
532
|
+
* link expires, you'll need to reset the user's password again.
|
|
533
|
+
* <p>
|
|
563
534
|
**Note:** The user's Console login is the unique name you specified when you created the user
|
|
564
535
|
* (see {@link #createUser(CreateUserRequest) createUser}).
|
|
565
536
|
*
|
|
566
|
-
* This operation
|
|
537
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
567
538
|
* @param CreateOrResetUIPasswordRequest
|
|
568
539
|
* @return CreateOrResetUIPasswordResponse
|
|
569
540
|
* @throws OciError when an error occurs
|
|
570
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
541
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateOrResetUIPassword.ts.html |here} to see how to use CreateOrResetUIPassword API.
|
|
571
542
|
*/
|
|
572
543
|
createOrResetUIPassword(createOrResetUIPasswordRequest: requests.CreateOrResetUIPasswordRequest): Promise<responses.CreateOrResetUIPasswordResponse>;
|
|
573
544
|
/**
|
|
574
545
|
* Creates a new policy in the specified compartment (either the tenancy or another of your compartments).
|
|
575
|
-
* If you're new to policies, see [
|
|
546
|
+
* If you're new to policies, see [Get Started with Policies](https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm).
|
|
576
547
|
* <p>
|
|
577
548
|
You must specify a *name* for the policy, which must be unique across all policies in your tenancy
|
|
578
549
|
* and cannot be changed.
|
|
@@ -581,29 +552,29 @@ export declare class IdentityClient {
|
|
|
581
552
|
* have to be unique, and you can change it anytime with {@link #updatePolicy(UpdatePolicyRequest) updatePolicy}.
|
|
582
553
|
* <p>
|
|
583
554
|
You must specify one or more policy statements in the statements array. For information about writing
|
|
584
|
-
* policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/
|
|
585
|
-
* [Common Policies](https://docs.cloud.oracle.com/Content/Identity/
|
|
555
|
+
* policies, see [How Policies Work](https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm) and
|
|
556
|
+
* [Common Policies](https://docs.cloud.oracle.com/Content/Identity/policiescommon/commonpolicies.htm).
|
|
586
557
|
* <p>
|
|
587
558
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the
|
|
588
559
|
* object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
589
560
|
* <p>
|
|
590
561
|
New policies take effect typically within 10 seconds.
|
|
591
562
|
*
|
|
592
|
-
* This operation
|
|
563
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
593
564
|
* @param CreatePolicyRequest
|
|
594
565
|
* @return CreatePolicyResponse
|
|
595
566
|
* @throws OciError when an error occurs
|
|
596
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
567
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreatePolicy.ts.html |here} to see how to use CreatePolicy API.
|
|
597
568
|
*/
|
|
598
569
|
createPolicy(createPolicyRequest: requests.CreatePolicyRequest): Promise<responses.CreatePolicyResponse>;
|
|
599
570
|
/**
|
|
600
571
|
* Creates a subscription to a region for a tenancy.
|
|
601
572
|
*
|
|
602
|
-
* This operation
|
|
573
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
603
574
|
* @param CreateRegionSubscriptionRequest
|
|
604
575
|
* @return CreateRegionSubscriptionResponse
|
|
605
576
|
* @throws OciError when an error occurs
|
|
606
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
577
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateRegionSubscription.ts.html |here} to see how to use CreateRegionSubscription API.
|
|
607
578
|
*/
|
|
608
579
|
createRegionSubscription(createRegionSubscriptionRequest: requests.CreateRegionSubscriptionRequest): Promise<responses.CreateRegionSubscriptionResponse>;
|
|
609
580
|
/**
|
|
@@ -612,11 +583,11 @@ export declare class IdentityClient {
|
|
|
612
583
|
* have to be unique, and you can change it anytime with
|
|
613
584
|
* {@link #updateSmtpCredential(UpdateSmtpCredentialRequest) updateSmtpCredential}.
|
|
614
585
|
*
|
|
615
|
-
* This operation
|
|
586
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
616
587
|
* @param CreateSmtpCredentialRequest
|
|
617
588
|
* @return CreateSmtpCredentialResponse
|
|
618
589
|
* @throws OciError when an error occurs
|
|
619
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
590
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateSmtpCredential.ts.html |here} to see how to use CreateSmtpCredential API.
|
|
620
591
|
*/
|
|
621
592
|
createSmtpCredential(createSmtpCredentialRequest: requests.CreateSmtpCredentialRequest): Promise<responses.CreateSmtpCredentialResponse>;
|
|
622
593
|
/**
|
|
@@ -633,11 +604,11 @@ export declare class IdentityClient {
|
|
|
633
604
|
* does not need to write a policy to give users this ability. To compare, administrators who have permission to the
|
|
634
605
|
* tenancy can use this operation to create a Swift password for any user, including themselves.
|
|
635
606
|
*
|
|
636
|
-
* This operation
|
|
607
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
637
608
|
* @param CreateSwiftPasswordRequest
|
|
638
609
|
* @return CreateSwiftPasswordResponse
|
|
639
610
|
* @throws OciError when an error occurs
|
|
640
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
611
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateSwiftPassword.ts.html |here} to see how to use CreateSwiftPassword API.
|
|
641
612
|
*/
|
|
642
613
|
createSwiftPassword(createSwiftPasswordRequest: requests.CreateSwiftPasswordRequest): Promise<responses.CreateSwiftPasswordResponse>;
|
|
643
614
|
/**
|
|
@@ -664,11 +635,11 @@ export declare class IdentityClient {
|
|
|
664
635
|
* * If a `validator` is set, the user applying the tag to a resource must select from a list
|
|
665
636
|
* of values that you supply with {@link #enumTagDefinitionValidator(EnumTagDefinitionValidatorRequest) enumTagDefinitionValidator}.
|
|
666
637
|
*
|
|
667
|
-
* This operation
|
|
638
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
668
639
|
* @param CreateTagRequest
|
|
669
640
|
* @return CreateTagResponse
|
|
670
641
|
* @throws OciError when an error occurs
|
|
671
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
642
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateTag.ts.html |here} to see how to use CreateTag API.
|
|
672
643
|
*/
|
|
673
644
|
createTag(createTagRequest: requests.CreateTagRequest): Promise<responses.CreateTagResponse>;
|
|
674
645
|
/**
|
|
@@ -681,11 +652,11 @@ export declare class IdentityClient {
|
|
|
681
652
|
* If the `isRequired` flag is set to \"true\", the value is set during resource creation.
|
|
682
653
|
* * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
|
|
683
654
|
*
|
|
684
|
-
* This operation
|
|
655
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
685
656
|
* @param CreateTagDefaultRequest
|
|
686
657
|
* @return CreateTagDefaultResponse
|
|
687
658
|
* @throws OciError when an error occurs
|
|
688
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
659
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateTagDefault.ts.html |here} to see how to use CreateTagDefault API.
|
|
689
660
|
*/
|
|
690
661
|
createTagDefault(createTagDefaultRequest: requests.CreateTagDefaultRequest): Promise<responses.CreateTagDefaultResponse>;
|
|
691
662
|
/**
|
|
@@ -704,16 +675,16 @@ export declare class IdentityClient {
|
|
|
704
675
|
* It does not have to be unique, and you can change it with
|
|
705
676
|
* {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}.
|
|
706
677
|
*
|
|
707
|
-
* This operation
|
|
678
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
708
679
|
* @param CreateTagNamespaceRequest
|
|
709
680
|
* @return CreateTagNamespaceResponse
|
|
710
681
|
* @throws OciError when an error occurs
|
|
711
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
682
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateTagNamespace.ts.html |here} to see how to use CreateTagNamespace API.
|
|
712
683
|
*/
|
|
713
684
|
createTagNamespace(createTagNamespaceRequest: requests.CreateTagNamespaceRequest): Promise<responses.CreateTagNamespaceResponse>;
|
|
714
685
|
/**
|
|
715
686
|
* Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other
|
|
716
|
-
* IAM Service components, see [Overview of
|
|
687
|
+
* IAM Service components, see [Overview of IAM](https://docs.cloud.oracle.com/Content/Identity/getstarted/identity-domains.htm).
|
|
717
688
|
* <p>
|
|
718
689
|
You must specify your tenancy's OCID as the compartment ID in the request object (remember that the
|
|
719
690
|
* tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and
|
|
@@ -748,38 +719,29 @@ export declare class IdentityClient {
|
|
|
748
719
|
* <p>
|
|
749
720
|
**Important:** Make sure to inform the new user which compartment(s) they have access to.
|
|
750
721
|
*
|
|
751
|
-
* This operation
|
|
722
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
752
723
|
* @param CreateUserRequest
|
|
753
724
|
* @return CreateUserResponse
|
|
754
725
|
* @throws OciError when an error occurs
|
|
755
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
726
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/CreateUser.ts.html |here} to see how to use CreateUser API.
|
|
756
727
|
*/
|
|
757
728
|
createUser(createUserRequest: requests.CreateUserRequest): Promise<responses.CreateUserResponse>;
|
|
758
729
|
/**
|
|
759
|
-
*
|
|
760
|
-
*
|
|
761
|
-
*
|
|
762
|
-
*
|
|
763
|
-
|
|
764
|
-
*
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
*
|
|
768
|
-
* <p>
|
|
769
|
-
- If the domain's {@code lifecycleState} is INACTIVE, returns 202 ACCEPTED with no action
|
|
770
|
-
* taken on service side.
|
|
771
|
-
* - If domain is of {@code type} DEFAULT or DEFAULT_LIGHTWEIGHT or domain's {@code lifecycleState}
|
|
772
|
-
* is not ACTIVE, returns 400 BAD REQUEST.
|
|
773
|
-
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
774
|
-
* - If any active Apps in domain, returns 400 BAD REQUEST.
|
|
775
|
-
* - If the authenticated user is part of the domain to be activated, returns 400 BAD REQUEST
|
|
776
|
-
* - If error occurs while deactivating domain, returns 500 INTERNAL SERVER ERROR.
|
|
730
|
+
* (For tenancies that support identity domains) Deactivates the specified identity domain. Identity domains must be in an ACTIVE
|
|
731
|
+
* `lifecycleState` and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate
|
|
732
|
+
* the default identity domain.
|
|
733
|
+
* <p>
|
|
734
|
+
After you send your request, the `lifecycleDetails` of this identity domain is set to DEACTIVATING. When the operation completes,
|
|
735
|
+
* then the `lifecycleDetails` is set to null and the `lifecycleState` is set to INACTIVE.
|
|
736
|
+
* <p>
|
|
737
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
738
|
+
* the operation's status.
|
|
777
739
|
*
|
|
778
|
-
* This operation
|
|
740
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
779
741
|
* @param DeactivateDomainRequest
|
|
780
742
|
* @return DeactivateDomainResponse
|
|
781
743
|
* @throws OciError when an error occurs
|
|
782
|
-
* @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.24.0/identity/DeactivateDomain.ts.html |here} to see how to use DeactivateDomain API.
|
|
783
745
|
*/
|
|
784
746
|
deactivateDomain(deactivateDomainRequest: requests.DeactivateDomainRequest): Promise<responses.DeactivateDomainResponse>;
|
|
785
747
|
/**
|
|
@@ -790,97 +752,87 @@ export declare class IdentityClient {
|
|
|
790
752
|
* To compare, administrators who have permission to the tenancy can use this operation to delete
|
|
791
753
|
* a key for any user, including themselves.
|
|
792
754
|
*
|
|
793
|
-
* This operation
|
|
755
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
794
756
|
* @param DeleteApiKeyRequest
|
|
795
757
|
* @return DeleteApiKeyResponse
|
|
796
758
|
* @throws OciError when an error occurs
|
|
797
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
759
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteApiKey.ts.html |here} to see how to use DeleteApiKey API.
|
|
798
760
|
*/
|
|
799
761
|
deleteApiKey(deleteApiKeyRequest: requests.DeleteApiKeyRequest): Promise<responses.DeleteApiKeyResponse>;
|
|
800
762
|
/**
|
|
801
763
|
* Deletes the specified auth token for the specified user.
|
|
802
764
|
*
|
|
803
|
-
* This operation
|
|
765
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
804
766
|
* @param DeleteAuthTokenRequest
|
|
805
767
|
* @return DeleteAuthTokenResponse
|
|
806
768
|
* @throws OciError when an error occurs
|
|
807
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
769
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteAuthToken.ts.html |here} to see how to use DeleteAuthToken API.
|
|
808
770
|
*/
|
|
809
771
|
deleteAuthToken(deleteAuthTokenRequest: requests.DeleteAuthTokenRequest): Promise<responses.DeleteAuthTokenResponse>;
|
|
810
772
|
/**
|
|
811
773
|
* Deletes the specified compartment. The compartment must be empty.
|
|
812
774
|
*
|
|
813
|
-
* This operation
|
|
775
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
814
776
|
* @param DeleteCompartmentRequest
|
|
815
777
|
* @return DeleteCompartmentResponse
|
|
816
778
|
* @throws OciError when an error occurs
|
|
817
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
779
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteCompartment.ts.html |here} to see how to use DeleteCompartment API.
|
|
818
780
|
*/
|
|
819
781
|
deleteCompartment(deleteCompartmentRequest: requests.DeleteCompartmentRequest): Promise<responses.DeleteCompartmentResponse>;
|
|
820
782
|
/**
|
|
821
783
|
* Deletes the specified secret key for the specified user.
|
|
822
784
|
*
|
|
823
|
-
* This operation
|
|
785
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
824
786
|
* @param DeleteCustomerSecretKeyRequest
|
|
825
787
|
* @return DeleteCustomerSecretKeyResponse
|
|
826
788
|
* @throws OciError when an error occurs
|
|
827
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
789
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteCustomerSecretKey.ts.html |here} to see how to use DeleteCustomerSecretKey API.
|
|
828
790
|
*/
|
|
829
791
|
deleteCustomerSecretKey(deleteCustomerSecretKeyRequest: requests.DeleteCustomerSecretKeyRequest): Promise<responses.DeleteCustomerSecretKeyResponse>;
|
|
830
792
|
/**
|
|
831
793
|
* Deletes the specified DB credential for the specified user.
|
|
832
794
|
*
|
|
833
|
-
* This operation
|
|
795
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
834
796
|
* @param DeleteDbCredentialRequest
|
|
835
797
|
* @return DeleteDbCredentialResponse
|
|
836
798
|
* @throws OciError when an error occurs
|
|
837
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
799
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteDbCredential.ts.html |here} to see how to use DeleteDbCredential API.
|
|
838
800
|
*/
|
|
839
801
|
deleteDbCredential(deleteDbCredentialRequest: requests.DeleteDbCredentialRequest): Promise<responses.DeleteDbCredentialResponse>;
|
|
840
802
|
/**
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
* - If any active Apps in domain, returns 400 BAD REQUEST.
|
|
856
|
-
* - If the authenticated user is part of the domain to be deleted, returns 400 BAD REQUEST.
|
|
857
|
-
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
858
|
-
*
|
|
859
|
-
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
860
|
-
* @param DeleteDomainRequest
|
|
861
|
-
* @return DeleteDomainResponse
|
|
862
|
-
* @throws OciError when an error occurs
|
|
863
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.20.0/identity/DeleteDomain.ts.html |here} to see how to use DeleteDomain API.
|
|
864
|
-
*/
|
|
803
|
+
* (For tenancies that support identity domains) Deletes an identity domain. The identity domain must have no active apps present in
|
|
804
|
+
* the underlying IDCS stripe. You must also deactivate the identity domain, rendering the `lifecycleState` of the identity domain INACTIVE.
|
|
805
|
+
* Furthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting.
|
|
806
|
+
* Lastly, you cannot delete the default identity domain. A tenancy must always have at least the default identity domain.
|
|
807
|
+
*
|
|
808
|
+
* To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
809
|
+
* the operation's status.
|
|
810
|
+
*
|
|
811
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
812
|
+
* @param DeleteDomainRequest
|
|
813
|
+
* @return DeleteDomainResponse
|
|
814
|
+
* @throws OciError when an error occurs
|
|
815
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteDomain.ts.html |here} to see how to use DeleteDomain API.
|
|
816
|
+
*/
|
|
865
817
|
deleteDomain(deleteDomainRequest: requests.DeleteDomainRequest): Promise<responses.DeleteDomainResponse>;
|
|
866
818
|
/**
|
|
867
819
|
* Deletes the specified dynamic group.
|
|
868
820
|
*
|
|
869
|
-
* This operation
|
|
821
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
870
822
|
* @param DeleteDynamicGroupRequest
|
|
871
823
|
* @return DeleteDynamicGroupResponse
|
|
872
824
|
* @throws OciError when an error occurs
|
|
873
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
825
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteDynamicGroup.ts.html |here} to see how to use DeleteDynamicGroup API.
|
|
874
826
|
*/
|
|
875
827
|
deleteDynamicGroup(deleteDynamicGroupRequest: requests.DeleteDynamicGroupRequest): Promise<responses.DeleteDynamicGroupResponse>;
|
|
876
828
|
/**
|
|
877
829
|
* Deletes the specified group. The group must be empty.
|
|
878
830
|
*
|
|
879
|
-
* This operation
|
|
831
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
880
832
|
* @param DeleteGroupRequest
|
|
881
833
|
* @return DeleteGroupResponse
|
|
882
834
|
* @throws OciError when an error occurs
|
|
883
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
835
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteGroup.ts.html |here} to see how to use DeleteGroup API.
|
|
884
836
|
*/
|
|
885
837
|
deleteGroup(deleteGroupRequest: requests.DeleteGroupRequest): Promise<responses.DeleteGroupResponse>;
|
|
886
838
|
/**
|
|
@@ -889,11 +841,11 @@ export declare class IdentityClient {
|
|
|
889
841
|
Deletes the specified identity provider. The identity provider must not have
|
|
890
842
|
* any group mappings (see {@link IdpGroupMapping}).
|
|
891
843
|
*
|
|
892
|
-
* This operation
|
|
844
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
893
845
|
* @param DeleteIdentityProviderRequest
|
|
894
846
|
* @return DeleteIdentityProviderResponse
|
|
895
847
|
* @throws OciError when an error occurs
|
|
896
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
848
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteIdentityProvider.ts.html |here} to see how to use DeleteIdentityProvider API.
|
|
897
849
|
*/
|
|
898
850
|
deleteIdentityProvider(deleteIdentityProviderRequest: requests.DeleteIdentityProviderRequest): Promise<responses.DeleteIdentityProviderResponse>;
|
|
899
851
|
/**
|
|
@@ -901,60 +853,60 @@ export declare class IdentityClient {
|
|
|
901
853
|
* <p>
|
|
902
854
|
Deletes the specified group mapping.
|
|
903
855
|
*
|
|
904
|
-
* This operation
|
|
856
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
905
857
|
* @param DeleteIdpGroupMappingRequest
|
|
906
858
|
* @return DeleteIdpGroupMappingResponse
|
|
907
859
|
* @throws OciError when an error occurs
|
|
908
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
860
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteIdpGroupMapping.ts.html |here} to see how to use DeleteIdpGroupMapping API.
|
|
909
861
|
*/
|
|
910
862
|
deleteIdpGroupMapping(deleteIdpGroupMappingRequest: requests.DeleteIdpGroupMappingRequest): Promise<responses.DeleteIdpGroupMappingResponse>;
|
|
911
863
|
/**
|
|
912
864
|
* Deletes the specified MFA TOTP device for the specified user.
|
|
913
865
|
*
|
|
914
|
-
* This operation
|
|
866
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
915
867
|
* @param DeleteMfaTotpDeviceRequest
|
|
916
868
|
* @return DeleteMfaTotpDeviceResponse
|
|
917
869
|
* @throws OciError when an error occurs
|
|
918
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
870
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteMfaTotpDevice.ts.html |here} to see how to use DeleteMfaTotpDevice API.
|
|
919
871
|
*/
|
|
920
872
|
deleteMfaTotpDevice(deleteMfaTotpDeviceRequest: requests.DeleteMfaTotpDeviceRequest): Promise<responses.DeleteMfaTotpDeviceResponse>;
|
|
921
873
|
/**
|
|
922
|
-
* Deletes the specified network source
|
|
874
|
+
* Deletes the specified network source.
|
|
923
875
|
*
|
|
924
|
-
* This operation
|
|
876
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
925
877
|
* @param DeleteNetworkSourceRequest
|
|
926
878
|
* @return DeleteNetworkSourceResponse
|
|
927
879
|
* @throws OciError when an error occurs
|
|
928
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
880
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteNetworkSource.ts.html |here} to see how to use DeleteNetworkSource API.
|
|
929
881
|
*/
|
|
930
882
|
deleteNetworkSource(deleteNetworkSourceRequest: requests.DeleteNetworkSourceRequest): Promise<responses.DeleteNetworkSourceResponse>;
|
|
931
883
|
/**
|
|
932
884
|
* Delete Oauth token for the user
|
|
933
885
|
*
|
|
934
|
-
* This operation
|
|
886
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
935
887
|
* @param DeleteOAuthClientCredentialRequest
|
|
936
888
|
* @return DeleteOAuthClientCredentialResponse
|
|
937
889
|
* @throws OciError when an error occurs
|
|
938
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
890
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteOAuthClientCredential.ts.html |here} to see how to use DeleteOAuthClientCredential API.
|
|
939
891
|
*/
|
|
940
892
|
deleteOAuthClientCredential(deleteOAuthClientCredentialRequest: requests.DeleteOAuthClientCredentialRequest): Promise<responses.DeleteOAuthClientCredentialResponse>;
|
|
941
893
|
/**
|
|
942
894
|
* Deletes the specified policy. The deletion takes effect typically within 10 seconds.
|
|
943
|
-
* This operation
|
|
895
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
944
896
|
* @param DeletePolicyRequest
|
|
945
897
|
* @return DeletePolicyResponse
|
|
946
898
|
* @throws OciError when an error occurs
|
|
947
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
899
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeletePolicy.ts.html |here} to see how to use DeletePolicy API.
|
|
948
900
|
*/
|
|
949
901
|
deletePolicy(deletePolicyRequest: requests.DeletePolicyRequest): Promise<responses.DeletePolicyResponse>;
|
|
950
902
|
/**
|
|
951
903
|
* Deletes the specified SMTP credential for the specified user.
|
|
952
904
|
*
|
|
953
|
-
* This operation
|
|
905
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
954
906
|
* @param DeleteSmtpCredentialRequest
|
|
955
907
|
* @return DeleteSmtpCredentialResponse
|
|
956
908
|
* @throws OciError when an error occurs
|
|
957
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
909
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteSmtpCredential.ts.html |here} to see how to use DeleteSmtpCredential API.
|
|
958
910
|
*/
|
|
959
911
|
deleteSmtpCredential(deleteSmtpCredentialRequest: requests.DeleteSmtpCredentialRequest): Promise<responses.DeleteSmtpCredentialResponse>;
|
|
960
912
|
/**
|
|
@@ -962,11 +914,11 @@ export declare class IdentityClient {
|
|
|
962
914
|
* <p>
|
|
963
915
|
Deletes the specified Swift password for the specified user.
|
|
964
916
|
*
|
|
965
|
-
* This operation
|
|
917
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
966
918
|
* @param DeleteSwiftPasswordRequest
|
|
967
919
|
* @return DeleteSwiftPasswordResponse
|
|
968
920
|
* @throws OciError when an error occurs
|
|
969
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
921
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteSwiftPassword.ts.html |here} to see how to use DeleteSwiftPassword API.
|
|
970
922
|
*/
|
|
971
923
|
deleteSwiftPassword(deleteSwiftPasswordRequest: requests.DeleteSwiftPasswordRequest): Promise<responses.DeleteSwiftPasswordResponse>;
|
|
972
924
|
/**
|
|
@@ -992,21 +944,21 @@ export declare class IdentityClient {
|
|
|
992
944
|
To delete a tag, you must first retire it. Use {@link #updateTag(UpdateTagRequest) updateTag}
|
|
993
945
|
* to retire a tag.
|
|
994
946
|
*
|
|
995
|
-
* This operation
|
|
947
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
996
948
|
* @param DeleteTagRequest
|
|
997
949
|
* @return DeleteTagResponse
|
|
998
950
|
* @throws OciError when an error occurs
|
|
999
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
951
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteTag.ts.html |here} to see how to use DeleteTag API.
|
|
1000
952
|
*/
|
|
1001
953
|
deleteTag(deleteTagRequest: requests.DeleteTagRequest): Promise<responses.DeleteTagResponse>;
|
|
1002
954
|
/**
|
|
1003
955
|
* Deletes the the specified tag default.
|
|
1004
956
|
*
|
|
1005
|
-
* This operation
|
|
957
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1006
958
|
* @param DeleteTagDefaultRequest
|
|
1007
959
|
* @return DeleteTagDefaultResponse
|
|
1008
960
|
* @throws OciError when an error occurs
|
|
1009
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
961
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteTagDefault.ts.html |here} to see how to use DeleteTagDefault API.
|
|
1010
962
|
*/
|
|
1011
963
|
deleteTagDefault(deleteTagDefaultRequest: requests.DeleteTagDefaultRequest): Promise<responses.DeleteTagDefaultResponse>;
|
|
1012
964
|
/**
|
|
@@ -1018,63 +970,60 @@ export declare class IdentityClient {
|
|
|
1018
970
|
* <p>
|
|
1019
971
|
Use {@link #deleteTag(DeleteTagRequest) deleteTag} to delete a tag definition.
|
|
1020
972
|
*
|
|
1021
|
-
* This operation
|
|
973
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1022
974
|
* @param DeleteTagNamespaceRequest
|
|
1023
975
|
* @return DeleteTagNamespaceResponse
|
|
1024
976
|
* @throws OciError when an error occurs
|
|
1025
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
977
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteTagNamespace.ts.html |here} to see how to use DeleteTagNamespace API.
|
|
1026
978
|
*/
|
|
1027
979
|
deleteTagNamespace(deleteTagNamespaceRequest: requests.DeleteTagNamespaceRequest): Promise<responses.DeleteTagNamespaceResponse>;
|
|
1028
980
|
/**
|
|
1029
981
|
* Deletes the specified user. The user must not be in any groups.
|
|
1030
|
-
* This operation
|
|
982
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1031
983
|
* @param DeleteUserRequest
|
|
1032
984
|
* @return DeleteUserResponse
|
|
1033
985
|
* @throws OciError when an error occurs
|
|
1034
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
986
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/DeleteUser.ts.html |here} to see how to use DeleteUser API.
|
|
1035
987
|
*/
|
|
1036
988
|
deleteUser(deleteUserRequest: requests.DeleteUserRequest): Promise<responses.DeleteUserResponse>;
|
|
1037
989
|
/**
|
|
1038
|
-
*
|
|
1039
|
-
*
|
|
1040
|
-
*
|
|
990
|
+
* (For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the
|
|
991
|
+
* tenancy home region or other region that the tenancy subscribes to). You can only replicate identity domains that are in an ACTIVE
|
|
992
|
+
* `lifecycleState` and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains.
|
|
993
|
+
* The default identity domain is automatically replicated to all regions that the tenancy subscribes to.
|
|
1041
994
|
* <p>
|
|
1042
|
-
|
|
1043
|
-
* the
|
|
995
|
+
After you send the request, the `state` of the identity domain in the replica region is set to ENABLING_REPLICATION. When the operation
|
|
996
|
+
* completes, the `state` is set to REPLICATION_ENABLED.
|
|
1044
997
|
* <p>
|
|
1045
|
-
|
|
1046
|
-
*
|
|
1047
|
-
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
1048
|
-
* - If home region is same as replication region, return 400 BAD REQUEST.
|
|
1049
|
-
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
1050
|
-
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
998
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
999
|
+
* the operation's status.
|
|
1051
1000
|
*
|
|
1052
|
-
* This operation
|
|
1001
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1053
1002
|
* @param EnableReplicationToRegionRequest
|
|
1054
1003
|
* @return EnableReplicationToRegionResponse
|
|
1055
1004
|
* @throws OciError when an error occurs
|
|
1056
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1005
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/EnableReplicationToRegion.ts.html |here} to see how to use EnableReplicationToRegion API.
|
|
1057
1006
|
*/
|
|
1058
1007
|
enableReplicationToRegion(enableReplicationToRegionRequest: requests.EnableReplicationToRegionRequest): Promise<responses.EnableReplicationToRegionResponse>;
|
|
1059
1008
|
/**
|
|
1060
1009
|
* Generate seed for the MFA TOTP device.
|
|
1061
1010
|
*
|
|
1062
|
-
* This operation
|
|
1011
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1063
1012
|
* @param GenerateTotpSeedRequest
|
|
1064
1013
|
* @return GenerateTotpSeedResponse
|
|
1065
1014
|
* @throws OciError when an error occurs
|
|
1066
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1015
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GenerateTotpSeed.ts.html |here} to see how to use GenerateTotpSeed API.
|
|
1067
1016
|
*/
|
|
1068
1017
|
generateTotpSeed(generateTotpSeedRequest: requests.GenerateTotpSeedRequest): Promise<responses.GenerateTotpSeedResponse>;
|
|
1069
1018
|
/**
|
|
1070
1019
|
* Gets the authentication policy for the given tenancy. You must specify your tenant\u2019s OCID as the value for
|
|
1071
1020
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1072
1021
|
*
|
|
1073
|
-
* This operation
|
|
1022
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1074
1023
|
* @param GetAuthenticationPolicyRequest
|
|
1075
1024
|
* @return GetAuthenticationPolicyResponse
|
|
1076
1025
|
* @throws OciError when an error occurs
|
|
1077
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1026
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetAuthenticationPolicy.ts.html |here} to see how to use GetAuthenticationPolicy API.
|
|
1078
1027
|
*/
|
|
1079
1028
|
getAuthenticationPolicy(getAuthenticationPolicyRequest: requests.GetAuthenticationPolicyRequest): Promise<responses.GetAuthenticationPolicyResponse>;
|
|
1080
1029
|
/**
|
|
@@ -1087,34 +1036,31 @@ export declare class IdentityClient {
|
|
|
1087
1036
|
* call the {@link #listInstances(ListInstancesRequest) listInstances} operation in the Cloud Compute
|
|
1088
1037
|
* Service or the {@link #listVolumes(ListVolumesRequest) listVolumes} operation in Cloud Block Storage.
|
|
1089
1038
|
*
|
|
1090
|
-
* This operation
|
|
1039
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1091
1040
|
* @param GetCompartmentRequest
|
|
1092
1041
|
* @return GetCompartmentResponse
|
|
1093
1042
|
* @throws OciError when an error occurs
|
|
1094
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1043
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetCompartment.ts.html |here} to see how to use GetCompartment API.
|
|
1095
1044
|
*/
|
|
1096
1045
|
getCompartment(getCompartmentRequest: requests.GetCompartmentRequest): Promise<responses.GetCompartmentResponse>;
|
|
1097
1046
|
/**
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
* @throws OciError when an error occurs
|
|
1107
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.20.0/identity/GetDomain.ts.html |here} to see how to use GetDomain API.
|
|
1108
|
-
*/
|
|
1047
|
+
* (For tenancies that support identity domains) Gets the specified identity domain's information.
|
|
1048
|
+
*
|
|
1049
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1050
|
+
* @param GetDomainRequest
|
|
1051
|
+
* @return GetDomainResponse
|
|
1052
|
+
* @throws OciError when an error occurs
|
|
1053
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetDomain.ts.html |here} to see how to use GetDomain API.
|
|
1054
|
+
*/
|
|
1109
1055
|
getDomain(getDomainRequest: requests.GetDomainRequest): Promise<responses.GetDomainResponse>;
|
|
1110
1056
|
/**
|
|
1111
1057
|
* Gets the specified dynamic group's information.
|
|
1112
1058
|
*
|
|
1113
|
-
* This operation
|
|
1059
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1114
1060
|
* @param GetDynamicGroupRequest
|
|
1115
1061
|
* @return GetDynamicGroupResponse
|
|
1116
1062
|
* @throws OciError when an error occurs
|
|
1117
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1063
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetDynamicGroup.ts.html |here} to see how to use GetDynamicGroup API.
|
|
1118
1064
|
*/
|
|
1119
1065
|
getDynamicGroup(getDynamicGroupRequest: requests.GetDynamicGroupRequest): Promise<responses.GetDynamicGroupResponse>;
|
|
1120
1066
|
/**
|
|
@@ -1124,37 +1070,33 @@ export declare class IdentityClient {
|
|
|
1124
1070
|
* {@link #listUserGroupMemberships(ListUserGroupMembershipsRequest) listUserGroupMemberships} and
|
|
1125
1071
|
* provide the group's OCID as a query parameter in the request.
|
|
1126
1072
|
*
|
|
1127
|
-
* This operation
|
|
1073
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1128
1074
|
* @param GetGroupRequest
|
|
1129
1075
|
* @return GetGroupResponse
|
|
1130
1076
|
* @throws OciError when an error occurs
|
|
1131
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1077
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetGroup.ts.html |here} to see how to use GetGroup API.
|
|
1132
1078
|
*/
|
|
1133
1079
|
getGroup(getGroupRequest: requests.GetGroupRequest): Promise<responses.GetGroupResponse>;
|
|
1134
1080
|
/**
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
* @return GetIamWorkRequestResponse
|
|
1144
|
-
* @throws OciError when an error occurs
|
|
1145
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.20.0/identity/GetIamWorkRequest.ts.html |here} to see how to use GetIamWorkRequest API.
|
|
1146
|
-
*/
|
|
1081
|
+
* Gets the details of a specified IAM work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.
|
|
1082
|
+
*
|
|
1083
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1084
|
+
* @param GetIamWorkRequestRequest
|
|
1085
|
+
* @return GetIamWorkRequestResponse
|
|
1086
|
+
* @throws OciError when an error occurs
|
|
1087
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetIamWorkRequest.ts.html |here} to see how to use GetIamWorkRequest API.
|
|
1088
|
+
*/
|
|
1147
1089
|
getIamWorkRequest(getIamWorkRequestRequest: requests.GetIamWorkRequestRequest): Promise<responses.GetIamWorkRequestResponse>;
|
|
1148
1090
|
/**
|
|
1149
1091
|
* **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
|
|
1150
1092
|
* <p>
|
|
1151
1093
|
Gets the specified identity provider's information.
|
|
1152
1094
|
*
|
|
1153
|
-
* This operation
|
|
1095
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1154
1096
|
* @param GetIdentityProviderRequest
|
|
1155
1097
|
* @return GetIdentityProviderResponse
|
|
1156
1098
|
* @throws OciError when an error occurs
|
|
1157
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1099
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetIdentityProvider.ts.html |here} to see how to use GetIdentityProvider API.
|
|
1158
1100
|
*/
|
|
1159
1101
|
getIdentityProvider(getIdentityProviderRequest: requests.GetIdentityProviderRequest): Promise<responses.GetIdentityProviderResponse>;
|
|
1160
1102
|
/**
|
|
@@ -1162,166 +1104,164 @@ export declare class IdentityClient {
|
|
|
1162
1104
|
* <p>
|
|
1163
1105
|
Gets the specified group mapping.
|
|
1164
1106
|
*
|
|
1165
|
-
* This operation
|
|
1107
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1166
1108
|
* @param GetIdpGroupMappingRequest
|
|
1167
1109
|
* @return GetIdpGroupMappingResponse
|
|
1168
1110
|
* @throws OciError when an error occurs
|
|
1169
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1111
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetIdpGroupMapping.ts.html |here} to see how to use GetIdpGroupMapping API.
|
|
1170
1112
|
*/
|
|
1171
1113
|
getIdpGroupMapping(getIdpGroupMappingRequest: requests.GetIdpGroupMappingRequest): Promise<responses.GetIdpGroupMappingResponse>;
|
|
1172
1114
|
/**
|
|
1173
1115
|
* Get the specified MFA TOTP device for the specified user.
|
|
1174
1116
|
*
|
|
1175
|
-
* This operation
|
|
1117
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1176
1118
|
* @param GetMfaTotpDeviceRequest
|
|
1177
1119
|
* @return GetMfaTotpDeviceResponse
|
|
1178
1120
|
* @throws OciError when an error occurs
|
|
1179
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1121
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetMfaTotpDevice.ts.html |here} to see how to use GetMfaTotpDevice API.
|
|
1180
1122
|
*/
|
|
1181
1123
|
getMfaTotpDevice(getMfaTotpDeviceRequest: requests.GetMfaTotpDeviceRequest): Promise<responses.GetMfaTotpDeviceResponse>;
|
|
1182
1124
|
/**
|
|
1183
1125
|
* Gets the specified network source's information.
|
|
1184
1126
|
*
|
|
1185
|
-
* This operation
|
|
1127
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1186
1128
|
* @param GetNetworkSourceRequest
|
|
1187
1129
|
* @return GetNetworkSourceResponse
|
|
1188
1130
|
* @throws OciError when an error occurs
|
|
1189
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1131
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetNetworkSource.ts.html |here} to see how to use GetNetworkSource API.
|
|
1190
1132
|
*/
|
|
1191
1133
|
getNetworkSource(getNetworkSourceRequest: requests.GetNetworkSourceRequest): Promise<responses.GetNetworkSourceResponse>;
|
|
1192
1134
|
/**
|
|
1193
1135
|
* Gets the specified policy's information.
|
|
1194
|
-
* This operation
|
|
1136
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1195
1137
|
* @param GetPolicyRequest
|
|
1196
1138
|
* @return GetPolicyResponse
|
|
1197
1139
|
* @throws OciError when an error occurs
|
|
1198
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1140
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetPolicy.ts.html |here} to see how to use GetPolicy API.
|
|
1199
1141
|
*/
|
|
1200
1142
|
getPolicy(getPolicyRequest: requests.GetPolicyRequest): Promise<responses.GetPolicyResponse>;
|
|
1201
1143
|
/**
|
|
1202
1144
|
* Retrieve the standard tag namespace template given the standard tag namespace name.
|
|
1203
1145
|
*
|
|
1204
|
-
* This operation
|
|
1146
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1205
1147
|
* @param GetStandardTagTemplateRequest
|
|
1206
1148
|
* @return GetStandardTagTemplateResponse
|
|
1207
1149
|
* @throws OciError when an error occurs
|
|
1208
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1150
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetStandardTagTemplate.ts.html |here} to see how to use GetStandardTagTemplate API.
|
|
1209
1151
|
*/
|
|
1210
1152
|
getStandardTagTemplate(getStandardTagTemplateRequest: requests.GetStandardTagTemplateRequest): Promise<responses.GetStandardTagTemplateResponse>;
|
|
1211
1153
|
/**
|
|
1212
1154
|
* Gets the specified tag's information.
|
|
1213
|
-
* This operation
|
|
1155
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1214
1156
|
* @param GetTagRequest
|
|
1215
1157
|
* @return GetTagResponse
|
|
1216
1158
|
* @throws OciError when an error occurs
|
|
1217
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1159
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetTag.ts.html |here} to see how to use GetTag API.
|
|
1218
1160
|
*/
|
|
1219
1161
|
getTag(getTagRequest: requests.GetTagRequest): Promise<responses.GetTagResponse>;
|
|
1220
1162
|
/**
|
|
1221
1163
|
* Retrieves the specified tag default.
|
|
1222
1164
|
*
|
|
1223
|
-
* This operation
|
|
1165
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1224
1166
|
* @param GetTagDefaultRequest
|
|
1225
1167
|
* @return GetTagDefaultResponse
|
|
1226
1168
|
* @throws OciError when an error occurs
|
|
1227
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1169
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetTagDefault.ts.html |here} to see how to use GetTagDefault API.
|
|
1228
1170
|
*/
|
|
1229
1171
|
getTagDefault(getTagDefaultRequest: requests.GetTagDefaultRequest): Promise<responses.GetTagDefaultResponse>;
|
|
1230
1172
|
/**
|
|
1231
1173
|
* Gets the specified tag namespace's information.
|
|
1232
1174
|
*
|
|
1233
|
-
* This operation
|
|
1175
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1234
1176
|
* @param GetTagNamespaceRequest
|
|
1235
1177
|
* @return GetTagNamespaceResponse
|
|
1236
1178
|
* @throws OciError when an error occurs
|
|
1237
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1179
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetTagNamespace.ts.html |here} to see how to use GetTagNamespace API.
|
|
1238
1180
|
*/
|
|
1239
1181
|
getTagNamespace(getTagNamespaceRequest: requests.GetTagNamespaceRequest): Promise<responses.GetTagNamespaceResponse>;
|
|
1240
1182
|
/**
|
|
1241
1183
|
* Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header
|
|
1242
1184
|
* for any asynchronous operation in tagging service.
|
|
1243
1185
|
*
|
|
1244
|
-
* This operation
|
|
1186
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1245
1187
|
* @param GetTaggingWorkRequestRequest
|
|
1246
1188
|
* @return GetTaggingWorkRequestResponse
|
|
1247
1189
|
* @throws OciError when an error occurs
|
|
1248
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1190
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetTaggingWorkRequest.ts.html |here} to see how to use GetTaggingWorkRequest API.
|
|
1249
1191
|
*/
|
|
1250
1192
|
getTaggingWorkRequest(getTaggingWorkRequestRequest: requests.GetTaggingWorkRequestRequest): Promise<responses.GetTaggingWorkRequestResponse>;
|
|
1251
1193
|
/**
|
|
1252
1194
|
* Get the specified tenancy's information.
|
|
1253
|
-
* This operation
|
|
1195
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1254
1196
|
* @param GetTenancyRequest
|
|
1255
1197
|
* @return GetTenancyResponse
|
|
1256
1198
|
* @throws OciError when an error occurs
|
|
1257
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1199
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetTenancy.ts.html |here} to see how to use GetTenancy API.
|
|
1258
1200
|
*/
|
|
1259
1201
|
getTenancy(getTenancyRequest: requests.GetTenancyRequest): Promise<responses.GetTenancyResponse>;
|
|
1260
1202
|
/**
|
|
1261
1203
|
* Gets the specified user's information.
|
|
1262
|
-
* This operation
|
|
1204
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1263
1205
|
* @param GetUserRequest
|
|
1264
1206
|
* @return GetUserResponse
|
|
1265
1207
|
* @throws OciError when an error occurs
|
|
1266
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1208
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetUser.ts.html |here} to see how to use GetUser API.
|
|
1267
1209
|
*/
|
|
1268
1210
|
getUser(getUserRequest: requests.GetUserRequest): Promise<responses.GetUserResponse>;
|
|
1269
1211
|
/**
|
|
1270
1212
|
* Gets the specified UserGroupMembership's information.
|
|
1271
|
-
* This operation
|
|
1213
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1272
1214
|
* @param GetUserGroupMembershipRequest
|
|
1273
1215
|
* @return GetUserGroupMembershipResponse
|
|
1274
1216
|
* @throws OciError when an error occurs
|
|
1275
|
-
* @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.24.0/identity/GetUserGroupMembership.ts.html |here} to see how to use GetUserGroupMembership API.
|
|
1276
1218
|
*/
|
|
1277
1219
|
getUserGroupMembership(getUserGroupMembershipRequest: requests.GetUserGroupMembershipRequest): Promise<responses.GetUserGroupMembershipResponse>;
|
|
1278
1220
|
/**
|
|
1279
1221
|
* Gets the specified user's console password information. The returned object contains the user's OCID,
|
|
1280
1222
|
* but not the password itself. The actual password is returned only when created or reset.
|
|
1281
1223
|
*
|
|
1282
|
-
* This operation
|
|
1224
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1283
1225
|
* @param GetUserUIPasswordInformationRequest
|
|
1284
1226
|
* @return GetUserUIPasswordInformationResponse
|
|
1285
1227
|
* @throws OciError when an error occurs
|
|
1286
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1228
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetUserUIPasswordInformation.ts.html |here} to see how to use GetUserUIPasswordInformation API.
|
|
1287
1229
|
*/
|
|
1288
1230
|
getUserUIPasswordInformation(getUserUIPasswordInformationRequest: requests.GetUserUIPasswordInformationRequest): Promise<responses.GetUserUIPasswordInformationResponse>;
|
|
1289
1231
|
/**
|
|
1290
1232
|
* Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header
|
|
1291
1233
|
* for any asynchronous operation in the compartment service.
|
|
1292
1234
|
*
|
|
1293
|
-
* This operation
|
|
1235
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1294
1236
|
* @param GetWorkRequestRequest
|
|
1295
1237
|
* @return GetWorkRequestResponse
|
|
1296
1238
|
* @throws OciError when an error occurs
|
|
1297
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1239
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
1298
1240
|
*/
|
|
1299
1241
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
1300
1242
|
/**
|
|
1301
1243
|
* OCI will release Tag Namespaces that our customers can import.
|
|
1302
1244
|
* These Tag Namespaces will provide Tags for our customers and Partners to provide consistency and enable data reporting.
|
|
1303
1245
|
*
|
|
1304
|
-
* This operation
|
|
1246
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1305
1247
|
* @param ImportStandardTagsRequest
|
|
1306
1248
|
* @return ImportStandardTagsResponse
|
|
1307
1249
|
* @throws OciError when an error occurs
|
|
1308
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1250
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ImportStandardTags.ts.html |here} to see how to use ImportStandardTags API.
|
|
1309
1251
|
*/
|
|
1310
1252
|
importStandardTags(importStandardTagsRequest: requests.ImportStandardTagsRequest): Promise<responses.ImportStandardTagsResponse>;
|
|
1311
1253
|
/**
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
* If {@code name} is provided, it filters and returns resources that match the given license type name.
|
|
1315
|
-
* Otherwise, returns all valid license types that are currently supported.
|
|
1254
|
+
* (For tenancies that support identity domains) Lists the license types for identity domains supported by Oracle Cloud Infrastructure.
|
|
1255
|
+
* (License types are also referred to as domain types.)
|
|
1316
1256
|
* <p>
|
|
1317
|
-
|
|
1318
|
-
*
|
|
1257
|
+
If `currentLicenseTypeName` is provided, then the request returns license types that the identity domain with the specified license
|
|
1258
|
+
* type name can change to. Otherwise, the request returns all valid license types currently supported.
|
|
1319
1259
|
*
|
|
1320
|
-
* This operation
|
|
1260
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1321
1261
|
* @param ListAllowedDomainLicenseTypesRequest
|
|
1322
1262
|
* @return ListAllowedDomainLicenseTypesResponse
|
|
1323
1263
|
* @throws OciError when an error occurs
|
|
1324
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1264
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListAllowedDomainLicenseTypes.ts.html |here} to see how to use ListAllowedDomainLicenseTypes API.
|
|
1325
1265
|
*/
|
|
1326
1266
|
listAllowedDomainLicenseTypes(listAllowedDomainLicenseTypesRequest: requests.ListAllowedDomainLicenseTypesRequest): Promise<responses.ListAllowedDomainLicenseTypesResponse>;
|
|
1327
1267
|
/**
|
|
@@ -1330,22 +1270,22 @@ export declare class IdentityClient {
|
|
|
1330
1270
|
Every user has permission to use this API call for *their own user ID*. An administrator in your
|
|
1331
1271
|
* organization does not need to write a policy to give users this ability.
|
|
1332
1272
|
*
|
|
1333
|
-
* This operation
|
|
1273
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1334
1274
|
* @param ListApiKeysRequest
|
|
1335
1275
|
* @return ListApiKeysResponse
|
|
1336
1276
|
* @throws OciError when an error occurs
|
|
1337
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1277
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListApiKeys.ts.html |here} to see how to use ListApiKeys API.
|
|
1338
1278
|
*/
|
|
1339
1279
|
listApiKeys(listApiKeysRequest: requests.ListApiKeysRequest): Promise<responses.ListApiKeysResponse>;
|
|
1340
1280
|
/**
|
|
1341
1281
|
* Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not
|
|
1342
1282
|
* the token itself. The actual token is returned only upon creation.
|
|
1343
1283
|
*
|
|
1344
|
-
* This operation
|
|
1284
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1345
1285
|
* @param ListAuthTokensRequest
|
|
1346
1286
|
* @return ListAuthTokensResponse
|
|
1347
1287
|
* @throws OciError when an error occurs
|
|
1348
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1288
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListAuthTokens.ts.html |here} to see how to use ListAuthTokens API.
|
|
1349
1289
|
*/
|
|
1350
1290
|
listAuthTokens(listAuthTokensRequest: requests.ListAuthTokensRequest): Promise<responses.ListAuthTokensResponse>;
|
|
1351
1291
|
/**
|
|
@@ -1355,11 +1295,11 @@ export declare class IdentityClient {
|
|
|
1355
1295
|
* Note that the order of the results returned can change if availability domains are added or removed; therefore, do not
|
|
1356
1296
|
* create a dependency on the list order.
|
|
1357
1297
|
*
|
|
1358
|
-
* This operation
|
|
1298
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1359
1299
|
* @param ListAvailabilityDomainsRequest
|
|
1360
1300
|
* @return ListAvailabilityDomainsResponse
|
|
1361
1301
|
* @throws OciError when an error occurs
|
|
1362
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1302
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListAvailabilityDomains.ts.html |here} to see how to use ListAvailabilityDomains API.
|
|
1363
1303
|
*/
|
|
1364
1304
|
listAvailabilityDomains(listAvailabilityDomainsRequest: requests.ListAvailabilityDomainsRequest): Promise<responses.ListAvailabilityDomainsResponse>;
|
|
1365
1305
|
/**
|
|
@@ -1371,21 +1311,21 @@ export declare class IdentityClient {
|
|
|
1371
1311
|
* require an [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types,
|
|
1372
1312
|
* such as buckets, require you to provide other identifying information.
|
|
1373
1313
|
*
|
|
1374
|
-
* This operation
|
|
1314
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1375
1315
|
* @param ListBulkActionResourceTypesRequest
|
|
1376
1316
|
* @return ListBulkActionResourceTypesResponse
|
|
1377
1317
|
* @throws OciError when an error occurs
|
|
1378
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1318
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListBulkActionResourceTypes.ts.html |here} to see how to use ListBulkActionResourceTypes API.
|
|
1379
1319
|
*/
|
|
1380
1320
|
listBulkActionResourceTypes(listBulkActionResourceTypesRequest: requests.ListBulkActionResourceTypesRequest): Promise<responses.ListBulkActionResourceTypesResponse>;
|
|
1381
1321
|
/**
|
|
1382
1322
|
* Lists the resource types that support bulk tag editing.
|
|
1383
1323
|
*
|
|
1384
|
-
* This operation
|
|
1324
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1385
1325
|
* @param ListBulkEditTagsResourceTypesRequest
|
|
1386
1326
|
* @return ListBulkEditTagsResourceTypesResponse
|
|
1387
1327
|
* @throws OciError when an error occurs
|
|
1388
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1328
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListBulkEditTagsResourceTypes.ts.html |here} to see how to use ListBulkEditTagsResourceTypes API.
|
|
1389
1329
|
*/
|
|
1390
1330
|
listBulkEditTagsResourceTypes(listBulkEditTagsResourceTypesRequest: requests.ListBulkEditTagsResourceTypesRequest): Promise<responses.ListBulkEditTagsResourceTypesResponse>;
|
|
1391
1331
|
/**
|
|
@@ -1408,11 +1348,11 @@ export declare class IdentityClient {
|
|
|
1408
1348
|
* <p>
|
|
1409
1349
|
See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1410
1350
|
*
|
|
1411
|
-
* This operation
|
|
1351
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1412
1352
|
* @param ListCompartmentsRequest
|
|
1413
1353
|
* @return ListCompartmentsResponse
|
|
1414
1354
|
* @throws OciError when an error occurs
|
|
1415
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1355
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListCompartments.ts.html |here} to see how to use ListCompartments API.
|
|
1416
1356
|
*/
|
|
1417
1357
|
listCompartments(listCompartmentsRequest: requests.ListCompartmentsRequest): Promise<responses.ListCompartmentsResponse>;
|
|
1418
1358
|
/**
|
|
@@ -1449,13 +1389,13 @@ export declare class IdentityClient {
|
|
|
1449
1389
|
listCompartmentsResponseIterator(request: requests.ListCompartmentsRequest): AsyncIterableIterator<responses.ListCompartmentsResponse>;
|
|
1450
1390
|
/**
|
|
1451
1391
|
* Lists all the tags enabled for cost-tracking in the specified tenancy. For information about
|
|
1452
|
-
* cost-tracking tags, see [Using Cost-tracking Tags](https://docs.cloud.oracle.com/Content/
|
|
1392
|
+
* cost-tracking tags, see [Using Cost-tracking Tags](https://docs.cloud.oracle.com/Content/Tagging/Tasks/usingcosttrackingtags.htm).
|
|
1453
1393
|
*
|
|
1454
|
-
* This operation
|
|
1394
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1455
1395
|
* @param ListCostTrackingTagsRequest
|
|
1456
1396
|
* @return ListCostTrackingTagsResponse
|
|
1457
1397
|
* @throws OciError when an error occurs
|
|
1458
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1398
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListCostTrackingTags.ts.html |here} to see how to use ListCostTrackingTags API.
|
|
1459
1399
|
*/
|
|
1460
1400
|
listCostTrackingTags(listCostTrackingTagsRequest: requests.ListCostTrackingTagsRequest): Promise<responses.ListCostTrackingTagsResponse>;
|
|
1461
1401
|
/**
|
|
@@ -1494,21 +1434,21 @@ export declare class IdentityClient {
|
|
|
1494
1434
|
* Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not
|
|
1495
1435
|
* the secret key itself. The actual secret key is returned only upon creation.
|
|
1496
1436
|
*
|
|
1497
|
-
* This operation
|
|
1437
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1498
1438
|
* @param ListCustomerSecretKeysRequest
|
|
1499
1439
|
* @return ListCustomerSecretKeysResponse
|
|
1500
1440
|
* @throws OciError when an error occurs
|
|
1501
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1441
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListCustomerSecretKeys.ts.html |here} to see how to use ListCustomerSecretKeys API.
|
|
1502
1442
|
*/
|
|
1503
1443
|
listCustomerSecretKeys(listCustomerSecretKeysRequest: requests.ListCustomerSecretKeysRequest): Promise<responses.ListCustomerSecretKeysResponse>;
|
|
1504
1444
|
/**
|
|
1505
1445
|
* Lists the DB credentials for the specified user. The returned object contains the credential's OCID
|
|
1506
1446
|
*
|
|
1507
|
-
* This operation
|
|
1447
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1508
1448
|
* @param ListDbCredentialsRequest
|
|
1509
1449
|
* @return ListDbCredentialsResponse
|
|
1510
1450
|
* @throws OciError when an error occurs
|
|
1511
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1451
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListDbCredentials.ts.html |here} to see how to use ListDbCredentials API.
|
|
1512
1452
|
*/
|
|
1513
1453
|
listDbCredentials(listDbCredentialsRequest: requests.ListDbCredentialsRequest): Promise<responses.ListDbCredentialsResponse>;
|
|
1514
1454
|
/**
|
|
@@ -1544,14 +1484,13 @@ export declare class IdentityClient {
|
|
|
1544
1484
|
*/
|
|
1545
1485
|
listDbCredentialsResponseIterator(request: requests.ListDbCredentialsRequest): AsyncIterableIterator<responses.ListDbCredentialsResponse>;
|
|
1546
1486
|
/**
|
|
1547
|
-
*
|
|
1548
|
-
* - If any internal error occurs, return 500 INTERNAL SERVER ERROR.
|
|
1487
|
+
* (For tenancies that support identity domains) Lists all identity domains within a tenancy.
|
|
1549
1488
|
*
|
|
1550
|
-
* This operation
|
|
1489
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1551
1490
|
* @param ListDomainsRequest
|
|
1552
1491
|
* @return ListDomainsResponse
|
|
1553
1492
|
* @throws OciError when an error occurs
|
|
1554
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1493
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListDomains.ts.html |here} to see how to use ListDomains API.
|
|
1555
1494
|
*/
|
|
1556
1495
|
listDomains(listDomainsRequest: requests.ListDomainsRequest): Promise<responses.ListDomainsResponse>;
|
|
1557
1496
|
/**
|
|
@@ -1591,11 +1530,11 @@ export declare class IdentityClient {
|
|
|
1591
1530
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1592
1531
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1593
1532
|
*
|
|
1594
|
-
* This operation
|
|
1533
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1595
1534
|
* @param ListDynamicGroupsRequest
|
|
1596
1535
|
* @return ListDynamicGroupsResponse
|
|
1597
1536
|
* @throws OciError when an error occurs
|
|
1598
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1537
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListDynamicGroups.ts.html |here} to see how to use ListDynamicGroups API.
|
|
1599
1538
|
*/
|
|
1600
1539
|
listDynamicGroups(listDynamicGroupsRequest: requests.ListDynamicGroupsRequest): Promise<responses.ListDynamicGroupsResponse>;
|
|
1601
1540
|
/**
|
|
@@ -1635,11 +1574,11 @@ export declare class IdentityClient {
|
|
|
1635
1574
|
* of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1636
1575
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1637
1576
|
*
|
|
1638
|
-
* This operation
|
|
1577
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1639
1578
|
* @param ListFaultDomainsRequest
|
|
1640
1579
|
* @return ListFaultDomainsResponse
|
|
1641
1580
|
* @throws OciError when an error occurs
|
|
1642
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1581
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListFaultDomains.ts.html |here} to see how to use ListFaultDomains API.
|
|
1643
1582
|
*/
|
|
1644
1583
|
listFaultDomains(listFaultDomainsRequest: requests.ListFaultDomainsRequest): Promise<responses.ListFaultDomainsResponse>;
|
|
1645
1584
|
/**
|
|
@@ -1647,11 +1586,11 @@ export declare class IdentityClient {
|
|
|
1647
1586
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
1648
1587
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1649
1588
|
*
|
|
1650
|
-
* This operation
|
|
1589
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1651
1590
|
* @param ListGroupsRequest
|
|
1652
1591
|
* @return ListGroupsResponse
|
|
1653
1592
|
* @throws OciError when an error occurs
|
|
1654
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1593
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListGroups.ts.html |here} to see how to use ListGroups API.
|
|
1655
1594
|
*/
|
|
1656
1595
|
listGroups(listGroupsRequest: requests.ListGroupsRequest): Promise<responses.ListGroupsResponse>;
|
|
1657
1596
|
/**
|
|
@@ -1687,18 +1626,14 @@ export declare class IdentityClient {
|
|
|
1687
1626
|
*/
|
|
1688
1627
|
listGroupsResponseIterator(request: requests.ListGroupsRequest): AsyncIterableIterator<responses.ListGroupsResponse>;
|
|
1689
1628
|
/**
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
* @return ListIamWorkRequestErrorsResponse
|
|
1699
|
-
* @throws OciError when an error occurs
|
|
1700
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.20.0/identity/ListIamWorkRequestErrors.ts.html |here} to see how to use ListIamWorkRequestErrors API.
|
|
1701
|
-
*/
|
|
1629
|
+
* Gets error details for a specified IAM work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.
|
|
1630
|
+
*
|
|
1631
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1632
|
+
* @param ListIamWorkRequestErrorsRequest
|
|
1633
|
+
* @return ListIamWorkRequestErrorsResponse
|
|
1634
|
+
* @throws OciError when an error occurs
|
|
1635
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListIamWorkRequestErrors.ts.html |here} to see how to use ListIamWorkRequestErrors API.
|
|
1636
|
+
*/
|
|
1702
1637
|
listIamWorkRequestErrors(listIamWorkRequestErrorsRequest: requests.ListIamWorkRequestErrorsRequest): Promise<responses.ListIamWorkRequestErrorsResponse>;
|
|
1703
1638
|
/**
|
|
1704
1639
|
* NOTE: This function is deprecated in favor of listIamWorkRequestErrorsRecordIterator function.
|
|
@@ -1733,18 +1668,14 @@ export declare class IdentityClient {
|
|
|
1733
1668
|
*/
|
|
1734
1669
|
listIamWorkRequestErrorsResponseIterator(request: requests.ListIamWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListIamWorkRequestErrorsResponse>;
|
|
1735
1670
|
/**
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
* @return ListIamWorkRequestLogsResponse
|
|
1745
|
-
* @throws OciError when an error occurs
|
|
1746
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.20.0/identity/ListIamWorkRequestLogs.ts.html |here} to see how to use ListIamWorkRequestLogs API.
|
|
1747
|
-
*/
|
|
1671
|
+
* Gets logs for a specified IAM work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.
|
|
1672
|
+
*
|
|
1673
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1674
|
+
* @param ListIamWorkRequestLogsRequest
|
|
1675
|
+
* @return ListIamWorkRequestLogsResponse
|
|
1676
|
+
* @throws OciError when an error occurs
|
|
1677
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListIamWorkRequestLogs.ts.html |here} to see how to use ListIamWorkRequestLogs API.
|
|
1678
|
+
*/
|
|
1748
1679
|
listIamWorkRequestLogs(listIamWorkRequestLogsRequest: requests.ListIamWorkRequestLogsRequest): Promise<responses.ListIamWorkRequestLogsResponse>;
|
|
1749
1680
|
/**
|
|
1750
1681
|
* NOTE: This function is deprecated in favor of listIamWorkRequestLogsRecordIterator function.
|
|
@@ -1779,17 +1710,14 @@ export declare class IdentityClient {
|
|
|
1779
1710
|
*/
|
|
1780
1711
|
listIamWorkRequestLogsResponseIterator(request: requests.ListIamWorkRequestLogsRequest): AsyncIterableIterator<responses.ListIamWorkRequestLogsResponse>;
|
|
1781
1712
|
/**
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
* @throws OciError when an error occurs
|
|
1791
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.20.0/identity/ListIamWorkRequests.ts.html |here} to see how to use ListIamWorkRequests API.
|
|
1792
|
-
*/
|
|
1713
|
+
* Lists the IAM work requests in compartment. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.
|
|
1714
|
+
*
|
|
1715
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1716
|
+
* @param ListIamWorkRequestsRequest
|
|
1717
|
+
* @return ListIamWorkRequestsResponse
|
|
1718
|
+
* @throws OciError when an error occurs
|
|
1719
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListIamWorkRequests.ts.html |here} to see how to use ListIamWorkRequests API.
|
|
1720
|
+
*/
|
|
1793
1721
|
listIamWorkRequests(listIamWorkRequestsRequest: requests.ListIamWorkRequestsRequest): Promise<responses.ListIamWorkRequestsResponse>;
|
|
1794
1722
|
/**
|
|
1795
1723
|
* NOTE: This function is deprecated in favor of listIamWorkRequestsRecordIterator function.
|
|
@@ -1828,11 +1756,11 @@ export declare class IdentityClient {
|
|
|
1828
1756
|
* <p>
|
|
1829
1757
|
Lists the identity provider groups.
|
|
1830
1758
|
*
|
|
1831
|
-
* This operation
|
|
1759
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1832
1760
|
* @param ListIdentityProviderGroupsRequest
|
|
1833
1761
|
* @return ListIdentityProviderGroupsResponse
|
|
1834
1762
|
* @throws OciError when an error occurs
|
|
1835
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1763
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListIdentityProviderGroups.ts.html |here} to see how to use ListIdentityProviderGroups API.
|
|
1836
1764
|
*/
|
|
1837
1765
|
listIdentityProviderGroups(listIdentityProviderGroupsRequest: requests.ListIdentityProviderGroupsRequest): Promise<responses.ListIdentityProviderGroupsResponse>;
|
|
1838
1766
|
/**
|
|
@@ -1875,11 +1803,11 @@ export declare class IdentityClient {
|
|
|
1875
1803
|
* compartment ID (remember that the tenancy is simply the root compartment).
|
|
1876
1804
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
1877
1805
|
*
|
|
1878
|
-
* This operation
|
|
1806
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1879
1807
|
* @param ListIdentityProvidersRequest
|
|
1880
1808
|
* @return ListIdentityProvidersResponse
|
|
1881
1809
|
* @throws OciError when an error occurs
|
|
1882
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1810
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListIdentityProviders.ts.html |here} to see how to use ListIdentityProviders API.
|
|
1883
1811
|
*/
|
|
1884
1812
|
listIdentityProviders(listIdentityProvidersRequest: requests.ListIdentityProvidersRequest): Promise<responses.ListIdentityProvidersResponse>;
|
|
1885
1813
|
/**
|
|
@@ -1919,11 +1847,11 @@ export declare class IdentityClient {
|
|
|
1919
1847
|
* <p>
|
|
1920
1848
|
Lists the group mappings for the specified identity provider.
|
|
1921
1849
|
*
|
|
1922
|
-
* This operation
|
|
1850
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1923
1851
|
* @param ListIdpGroupMappingsRequest
|
|
1924
1852
|
* @return ListIdpGroupMappingsResponse
|
|
1925
1853
|
* @throws OciError when an error occurs
|
|
1926
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1854
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListIdpGroupMappings.ts.html |here} to see how to use ListIdpGroupMappings API.
|
|
1927
1855
|
*/
|
|
1928
1856
|
listIdpGroupMappings(listIdpGroupMappingsRequest: requests.ListIdpGroupMappingsRequest): Promise<responses.ListIdpGroupMappingsResponse>;
|
|
1929
1857
|
/**
|
|
@@ -1962,11 +1890,11 @@ export declare class IdentityClient {
|
|
|
1962
1890
|
* Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not
|
|
1963
1891
|
* the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.
|
|
1964
1892
|
*
|
|
1965
|
-
* This operation
|
|
1893
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
1966
1894
|
* @param ListMfaTotpDevicesRequest
|
|
1967
1895
|
* @return ListMfaTotpDevicesResponse
|
|
1968
1896
|
* @throws OciError when an error occurs
|
|
1969
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1897
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListMfaTotpDevices.ts.html |here} to see how to use ListMfaTotpDevices API.
|
|
1970
1898
|
*/
|
|
1971
1899
|
listMfaTotpDevices(listMfaTotpDevicesRequest: requests.ListMfaTotpDevicesRequest): Promise<responses.ListMfaTotpDevicesResponse>;
|
|
1972
1900
|
/**
|
|
@@ -2006,11 +1934,11 @@ export declare class IdentityClient {
|
|
|
2006
1934
|
* the compartment ID (remember that the tenancy is simply the root compartment).
|
|
2007
1935
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
2008
1936
|
*
|
|
2009
|
-
* This operation
|
|
1937
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2010
1938
|
* @param ListNetworkSourcesRequest
|
|
2011
1939
|
* @return ListNetworkSourcesResponse
|
|
2012
1940
|
* @throws OciError when an error occurs
|
|
2013
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1941
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListNetworkSources.ts.html |here} to see how to use ListNetworkSources API.
|
|
2014
1942
|
*/
|
|
2015
1943
|
listNetworkSources(listNetworkSourcesRequest: requests.ListNetworkSourcesRequest): Promise<responses.ListNetworkSourcesResponse>;
|
|
2016
1944
|
/**
|
|
@@ -2048,11 +1976,11 @@ export declare class IdentityClient {
|
|
|
2048
1976
|
/**
|
|
2049
1977
|
* List of Oauth tokens for the user
|
|
2050
1978
|
*
|
|
2051
|
-
* This operation
|
|
1979
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2052
1980
|
* @param ListOAuthClientCredentialsRequest
|
|
2053
1981
|
* @return ListOAuthClientCredentialsResponse
|
|
2054
1982
|
* @throws OciError when an error occurs
|
|
2055
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1983
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListOAuthClientCredentials.ts.html |here} to see how to use ListOAuthClientCredentials API.
|
|
2056
1984
|
*/
|
|
2057
1985
|
listOAuthClientCredentials(listOAuthClientCredentialsRequest: requests.ListOAuthClientCredentialsRequest): Promise<responses.ListOAuthClientCredentialsResponse>;
|
|
2058
1986
|
/**
|
|
@@ -2094,11 +2022,11 @@ export declare class IdentityClient {
|
|
|
2094
2022
|
To determine which policies apply to a particular group or compartment, you must view the individual
|
|
2095
2023
|
* statements inside all your policies. There isn't a way to automatically obtain that information via the API.
|
|
2096
2024
|
*
|
|
2097
|
-
* This operation
|
|
2025
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2098
2026
|
* @param ListPoliciesRequest
|
|
2099
2027
|
* @return ListPoliciesResponse
|
|
2100
2028
|
* @throws OciError when an error occurs
|
|
2101
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2029
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListPolicies.ts.html |here} to see how to use ListPolicies API.
|
|
2102
2030
|
*/
|
|
2103
2031
|
listPolicies(listPoliciesRequest: requests.ListPoliciesRequest): Promise<responses.ListPoliciesResponse>;
|
|
2104
2032
|
/**
|
|
@@ -2135,41 +2063,41 @@ export declare class IdentityClient {
|
|
|
2135
2063
|
listPoliciesResponseIterator(request: requests.ListPoliciesRequest): AsyncIterableIterator<responses.ListPoliciesResponse>;
|
|
2136
2064
|
/**
|
|
2137
2065
|
* Lists the region subscriptions for the specified tenancy.
|
|
2138
|
-
* This operation
|
|
2066
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2139
2067
|
* @param ListRegionSubscriptionsRequest
|
|
2140
2068
|
* @return ListRegionSubscriptionsResponse
|
|
2141
2069
|
* @throws OciError when an error occurs
|
|
2142
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2070
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListRegionSubscriptions.ts.html |here} to see how to use ListRegionSubscriptions API.
|
|
2143
2071
|
*/
|
|
2144
2072
|
listRegionSubscriptions(listRegionSubscriptionsRequest: requests.ListRegionSubscriptionsRequest): Promise<responses.ListRegionSubscriptionsResponse>;
|
|
2145
2073
|
/**
|
|
2146
2074
|
* Lists all the regions offered by Oracle Cloud Infrastructure.
|
|
2147
|
-
* This operation
|
|
2075
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2148
2076
|
* @param ListRegionsRequest
|
|
2149
2077
|
* @return ListRegionsResponse
|
|
2150
2078
|
* @throws OciError when an error occurs
|
|
2151
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2079
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListRegions.ts.html |here} to see how to use ListRegions API.
|
|
2152
2080
|
*/
|
|
2153
2081
|
listRegions(listRegionsRequest: requests.ListRegionsRequest): Promise<responses.ListRegionsResponse>;
|
|
2154
2082
|
/**
|
|
2155
2083
|
* Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,
|
|
2156
2084
|
* the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.
|
|
2157
2085
|
*
|
|
2158
|
-
* This operation
|
|
2086
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2159
2087
|
* @param ListSmtpCredentialsRequest
|
|
2160
2088
|
* @return ListSmtpCredentialsResponse
|
|
2161
2089
|
* @throws OciError when an error occurs
|
|
2162
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2090
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListSmtpCredentials.ts.html |here} to see how to use ListSmtpCredentials API.
|
|
2163
2091
|
*/
|
|
2164
2092
|
listSmtpCredentials(listSmtpCredentialsRequest: requests.ListSmtpCredentialsRequest): Promise<responses.ListSmtpCredentialsResponse>;
|
|
2165
2093
|
/**
|
|
2166
2094
|
* Lists available standard tag namespaces that users can create.
|
|
2167
2095
|
*
|
|
2168
|
-
* This operation
|
|
2096
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2169
2097
|
* @param ListStandardTagNamespacesRequest
|
|
2170
2098
|
* @return ListStandardTagNamespacesResponse
|
|
2171
2099
|
* @throws OciError when an error occurs
|
|
2172
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2100
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListStandardTagNamespaces.ts.html |here} to see how to use ListStandardTagNamespaces API.
|
|
2173
2101
|
*/
|
|
2174
2102
|
listStandardTagNamespaces(listStandardTagNamespacesRequest: requests.ListStandardTagNamespacesRequest): Promise<responses.ListStandardTagNamespacesResponse>;
|
|
2175
2103
|
/**
|
|
@@ -2210,21 +2138,21 @@ export declare class IdentityClient {
|
|
|
2210
2138
|
Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not
|
|
2211
2139
|
* the password itself. The actual password is returned only upon creation.
|
|
2212
2140
|
*
|
|
2213
|
-
* This operation
|
|
2141
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2214
2142
|
* @param ListSwiftPasswordsRequest
|
|
2215
2143
|
* @return ListSwiftPasswordsResponse
|
|
2216
2144
|
* @throws OciError when an error occurs
|
|
2217
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2145
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListSwiftPasswords.ts.html |here} to see how to use ListSwiftPasswords API.
|
|
2218
2146
|
*/
|
|
2219
2147
|
listSwiftPasswords(listSwiftPasswordsRequest: requests.ListSwiftPasswordsRequest): Promise<responses.ListSwiftPasswordsResponse>;
|
|
2220
2148
|
/**
|
|
2221
2149
|
* Lists the tag defaults for tag definitions in the specified compartment.
|
|
2222
2150
|
*
|
|
2223
|
-
* This operation
|
|
2151
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2224
2152
|
* @param ListTagDefaultsRequest
|
|
2225
2153
|
* @return ListTagDefaultsResponse
|
|
2226
2154
|
* @throws OciError when an error occurs
|
|
2227
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2155
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListTagDefaults.ts.html |here} to see how to use ListTagDefaults API.
|
|
2228
2156
|
*/
|
|
2229
2157
|
listTagDefaults(listTagDefaultsRequest: requests.ListTagDefaultsRequest): Promise<responses.ListTagDefaultsResponse>;
|
|
2230
2158
|
/**
|
|
@@ -2262,11 +2190,11 @@ export declare class IdentityClient {
|
|
|
2262
2190
|
/**
|
|
2263
2191
|
* Lists the tag namespaces in the specified compartment.
|
|
2264
2192
|
*
|
|
2265
|
-
* This operation
|
|
2193
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2266
2194
|
* @param ListTagNamespacesRequest
|
|
2267
2195
|
* @return ListTagNamespacesResponse
|
|
2268
2196
|
* @throws OciError when an error occurs
|
|
2269
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2197
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListTagNamespaces.ts.html |here} to see how to use ListTagNamespaces API.
|
|
2270
2198
|
*/
|
|
2271
2199
|
listTagNamespaces(listTagNamespacesRequest: requests.ListTagNamespacesRequest): Promise<responses.ListTagNamespacesResponse>;
|
|
2272
2200
|
/**
|
|
@@ -2304,11 +2232,11 @@ export declare class IdentityClient {
|
|
|
2304
2232
|
/**
|
|
2305
2233
|
* Gets the errors for a work request.
|
|
2306
2234
|
*
|
|
2307
|
-
* This operation
|
|
2235
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2308
2236
|
* @param ListTaggingWorkRequestErrorsRequest
|
|
2309
2237
|
* @return ListTaggingWorkRequestErrorsResponse
|
|
2310
2238
|
* @throws OciError when an error occurs
|
|
2311
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2239
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListTaggingWorkRequestErrors.ts.html |here} to see how to use ListTaggingWorkRequestErrors API.
|
|
2312
2240
|
*/
|
|
2313
2241
|
listTaggingWorkRequestErrors(listTaggingWorkRequestErrorsRequest: requests.ListTaggingWorkRequestErrorsRequest): Promise<responses.ListTaggingWorkRequestErrorsResponse>;
|
|
2314
2242
|
/**
|
|
@@ -2346,11 +2274,11 @@ export declare class IdentityClient {
|
|
|
2346
2274
|
/**
|
|
2347
2275
|
* Gets the logs for a work request.
|
|
2348
2276
|
*
|
|
2349
|
-
* This operation
|
|
2277
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2350
2278
|
* @param ListTaggingWorkRequestLogsRequest
|
|
2351
2279
|
* @return ListTaggingWorkRequestLogsResponse
|
|
2352
2280
|
* @throws OciError when an error occurs
|
|
2353
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2281
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListTaggingWorkRequestLogs.ts.html |here} to see how to use ListTaggingWorkRequestLogs API.
|
|
2354
2282
|
*/
|
|
2355
2283
|
listTaggingWorkRequestLogs(listTaggingWorkRequestLogsRequest: requests.ListTaggingWorkRequestLogsRequest): Promise<responses.ListTaggingWorkRequestLogsResponse>;
|
|
2356
2284
|
/**
|
|
@@ -2388,11 +2316,11 @@ export declare class IdentityClient {
|
|
|
2388
2316
|
/**
|
|
2389
2317
|
* Lists the tagging work requests in compartment.
|
|
2390
2318
|
*
|
|
2391
|
-
* This operation
|
|
2319
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2392
2320
|
* @param ListTaggingWorkRequestsRequest
|
|
2393
2321
|
* @return ListTaggingWorkRequestsResponse
|
|
2394
2322
|
* @throws OciError when an error occurs
|
|
2395
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2323
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListTaggingWorkRequests.ts.html |here} to see how to use ListTaggingWorkRequests API.
|
|
2396
2324
|
*/
|
|
2397
2325
|
listTaggingWorkRequests(listTaggingWorkRequestsRequest: requests.ListTaggingWorkRequestsRequest): Promise<responses.ListTaggingWorkRequestsResponse>;
|
|
2398
2326
|
/**
|
|
@@ -2430,11 +2358,11 @@ export declare class IdentityClient {
|
|
|
2430
2358
|
/**
|
|
2431
2359
|
* Lists the tag definitions in the specified tag namespace.
|
|
2432
2360
|
*
|
|
2433
|
-
* This operation
|
|
2361
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2434
2362
|
* @param ListTagsRequest
|
|
2435
2363
|
* @return ListTagsResponse
|
|
2436
2364
|
* @throws OciError when an error occurs
|
|
2437
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2365
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListTags.ts.html |here} to see how to use ListTags API.
|
|
2438
2366
|
*/
|
|
2439
2367
|
listTags(listTagsRequest: requests.ListTagsRequest): Promise<responses.ListTagsResponse>;
|
|
2440
2368
|
/**
|
|
@@ -2481,11 +2409,11 @@ export declare class IdentityClient {
|
|
|
2481
2409
|
* If the answer is no, the response is an empty list.
|
|
2482
2410
|
* - Although`userId` and `groupId` are not individually required, you must set one of them.
|
|
2483
2411
|
*
|
|
2484
|
-
* This operation
|
|
2412
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2485
2413
|
* @param ListUserGroupMembershipsRequest
|
|
2486
2414
|
* @return ListUserGroupMembershipsResponse
|
|
2487
2415
|
* @throws OciError when an error occurs
|
|
2488
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2416
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListUserGroupMemberships.ts.html |here} to see how to use ListUserGroupMemberships API.
|
|
2489
2417
|
*/
|
|
2490
2418
|
listUserGroupMemberships(listUserGroupMembershipsRequest: requests.ListUserGroupMembershipsRequest): Promise<responses.ListUserGroupMembershipsResponse>;
|
|
2491
2419
|
/**
|
|
@@ -2525,11 +2453,11 @@ export declare class IdentityClient {
|
|
|
2525
2453
|
* compartment ID (remember that the tenancy is simply the root compartment).
|
|
2526
2454
|
* See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
|
|
2527
2455
|
*
|
|
2528
|
-
* This operation
|
|
2456
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2529
2457
|
* @param ListUsersRequest
|
|
2530
2458
|
* @return ListUsersResponse
|
|
2531
2459
|
* @throws OciError when an error occurs
|
|
2532
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2460
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListUsers.ts.html |here} to see how to use ListUsers API.
|
|
2533
2461
|
*/
|
|
2534
2462
|
listUsers(listUsersRequest: requests.ListUsersRequest): Promise<responses.ListUsersResponse>;
|
|
2535
2463
|
/**
|
|
@@ -2567,11 +2495,11 @@ export declare class IdentityClient {
|
|
|
2567
2495
|
/**
|
|
2568
2496
|
* Lists the work requests in compartment.
|
|
2569
2497
|
*
|
|
2570
|
-
* This operation
|
|
2498
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2571
2499
|
* @param ListWorkRequestsRequest
|
|
2572
2500
|
* @return ListWorkRequestsResponse
|
|
2573
2501
|
* @throws OciError when an error occurs
|
|
2574
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2502
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
2575
2503
|
*/
|
|
2576
2504
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
2577
2505
|
/**
|
|
@@ -2614,120 +2542,112 @@ export declare class IdentityClient {
|
|
|
2614
2542
|
**IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of
|
|
2615
2543
|
* the new parent take effect and the policies of the previous parent no longer apply. Ensure that you
|
|
2616
2544
|
* are aware of the implications for the compartment contents before you move it. For more
|
|
2617
|
-
* information, see [Moving a Compartment](https://docs.cloud.oracle.com/Content/Identity/
|
|
2545
|
+
* information, see [Moving a Compartment](https://docs.cloud.oracle.com/Content/Identity/compartments/managingcompartments.htm#MoveCompartment).
|
|
2618
2546
|
*
|
|
2619
|
-
* This operation
|
|
2547
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2620
2548
|
* @param MoveCompartmentRequest
|
|
2621
2549
|
* @return MoveCompartmentResponse
|
|
2622
2550
|
* @throws OciError when an error occurs
|
|
2623
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2551
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/MoveCompartment.ts.html |here} to see how to use MoveCompartment API.
|
|
2624
2552
|
*/
|
|
2625
2553
|
moveCompartment(moveCompartmentRequest: requests.MoveCompartmentRequest): Promise<responses.MoveCompartmentResponse>;
|
|
2626
2554
|
/**
|
|
2627
2555
|
* Recover the compartment from DELETED state to ACTIVE state.
|
|
2628
2556
|
*
|
|
2629
|
-
* This operation
|
|
2557
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2630
2558
|
* @param RecoverCompartmentRequest
|
|
2631
2559
|
* @return RecoverCompartmentResponse
|
|
2632
2560
|
* @throws OciError when an error occurs
|
|
2633
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2561
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/RecoverCompartment.ts.html |here} to see how to use RecoverCompartment API.
|
|
2634
2562
|
*/
|
|
2635
2563
|
recoverCompartment(recoverCompartmentRequest: requests.RecoverCompartmentRequest): Promise<responses.RecoverCompartmentResponse>;
|
|
2636
2564
|
/**
|
|
2637
2565
|
* Removes a user from a group by deleting the corresponding `UserGroupMembership`.
|
|
2638
|
-
* This operation
|
|
2566
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2639
2567
|
* @param RemoveUserFromGroupRequest
|
|
2640
2568
|
* @return RemoveUserFromGroupResponse
|
|
2641
2569
|
* @throws OciError when an error occurs
|
|
2642
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2570
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/RemoveUserFromGroup.ts.html |here} to see how to use RemoveUserFromGroup API.
|
|
2643
2571
|
*/
|
|
2644
2572
|
removeUserFromGroup(removeUserFromGroupRequest: requests.RemoveUserFromGroupRequest): Promise<responses.RemoveUserFromGroupResponse>;
|
|
2645
2573
|
/**
|
|
2646
2574
|
* Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
|
|
2647
2575
|
*
|
|
2648
|
-
* This operation
|
|
2576
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2649
2577
|
* @param ResetIdpScimClientRequest
|
|
2650
2578
|
* @return ResetIdpScimClientResponse
|
|
2651
2579
|
* @throws OciError when an error occurs
|
|
2652
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2580
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/ResetIdpScimClient.ts.html |here} to see how to use ResetIdpScimClient API.
|
|
2653
2581
|
*/
|
|
2654
2582
|
resetIdpScimClient(resetIdpScimClientRequest: requests.ResetIdpScimClientRequest): Promise<responses.ResetIdpScimClientResponse>;
|
|
2655
2583
|
/**
|
|
2656
2584
|
* Updates the specified auth token's description.
|
|
2657
2585
|
*
|
|
2658
|
-
* This operation
|
|
2586
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2659
2587
|
* @param UpdateAuthTokenRequest
|
|
2660
2588
|
* @return UpdateAuthTokenResponse
|
|
2661
2589
|
* @throws OciError when an error occurs
|
|
2662
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2590
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateAuthToken.ts.html |here} to see how to use UpdateAuthToken API.
|
|
2663
2591
|
*/
|
|
2664
2592
|
updateAuthToken(updateAuthTokenRequest: requests.UpdateAuthTokenRequest): Promise<responses.UpdateAuthTokenResponse>;
|
|
2665
2593
|
/**
|
|
2666
|
-
* Updates authentication policy for the specified tenancy
|
|
2594
|
+
* Updates authentication policy for the specified tenancy.
|
|
2667
2595
|
*
|
|
2668
|
-
* This operation
|
|
2596
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2669
2597
|
* @param UpdateAuthenticationPolicyRequest
|
|
2670
2598
|
* @return UpdateAuthenticationPolicyResponse
|
|
2671
2599
|
* @throws OciError when an error occurs
|
|
2672
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2600
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateAuthenticationPolicy.ts.html |here} to see how to use UpdateAuthenticationPolicy API.
|
|
2673
2601
|
*/
|
|
2674
2602
|
updateAuthenticationPolicy(updateAuthenticationPolicyRequest: requests.UpdateAuthenticationPolicyRequest): Promise<responses.UpdateAuthenticationPolicyResponse>;
|
|
2675
2603
|
/**
|
|
2676
2604
|
* Updates the specified compartment's description or name. You can't update the root compartment.
|
|
2677
|
-
* This operation
|
|
2605
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2678
2606
|
* @param UpdateCompartmentRequest
|
|
2679
2607
|
* @return UpdateCompartmentResponse
|
|
2680
2608
|
* @throws OciError when an error occurs
|
|
2681
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2609
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateCompartment.ts.html |here} to see how to use UpdateCompartment API.
|
|
2682
2610
|
*/
|
|
2683
2611
|
updateCompartment(updateCompartmentRequest: requests.UpdateCompartmentRequest): Promise<responses.UpdateCompartmentResponse>;
|
|
2684
2612
|
/**
|
|
2685
2613
|
* Updates the specified secret key's description.
|
|
2686
2614
|
*
|
|
2687
|
-
* This operation
|
|
2615
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2688
2616
|
* @param UpdateCustomerSecretKeyRequest
|
|
2689
2617
|
* @return UpdateCustomerSecretKeyResponse
|
|
2690
2618
|
* @throws OciError when an error occurs
|
|
2691
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2619
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateCustomerSecretKey.ts.html |here} to see how to use UpdateCustomerSecretKey API.
|
|
2692
2620
|
*/
|
|
2693
2621
|
updateCustomerSecretKey(updateCustomerSecretKeyRequest: requests.UpdateCustomerSecretKeyRequest): Promise<responses.UpdateCustomerSecretKeyResponse>;
|
|
2694
2622
|
/**
|
|
2695
|
-
* Updates domain information and associated
|
|
2696
|
-
* the associated stripe and domain are updated.
|
|
2697
|
-
* <p>
|
|
2698
|
-
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide
|
|
2699
|
-
* the async operation's status.
|
|
2623
|
+
* (For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe.
|
|
2700
2624
|
* <p>
|
|
2701
|
-
|
|
2702
|
-
*
|
|
2703
|
-
* returns 400 BAD REQUEST.
|
|
2704
|
-
* - If Domain is not active or being updated, returns 400 BAD REQUEST.
|
|
2705
|
-
* - If Domain {@code type} is DEFAULT or DEFAULT_LIGHTWEIGHT, return 400 BAD Request
|
|
2706
|
-
* - If the domain doesn't exists, returns 404 NOT FOUND.
|
|
2625
|
+
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
|
|
2626
|
+
* the operation's status.
|
|
2707
2627
|
*
|
|
2708
|
-
* This operation
|
|
2628
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2709
2629
|
* @param UpdateDomainRequest
|
|
2710
2630
|
* @return UpdateDomainResponse
|
|
2711
2631
|
* @throws OciError when an error occurs
|
|
2712
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2632
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateDomain.ts.html |here} to see how to use UpdateDomain API.
|
|
2713
2633
|
*/
|
|
2714
2634
|
updateDomain(updateDomainRequest: requests.UpdateDomainRequest): Promise<responses.UpdateDomainResponse>;
|
|
2715
2635
|
/**
|
|
2716
2636
|
* Updates the specified dynamic group.
|
|
2717
|
-
* This operation
|
|
2637
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2718
2638
|
* @param UpdateDynamicGroupRequest
|
|
2719
2639
|
* @return UpdateDynamicGroupResponse
|
|
2720
2640
|
* @throws OciError when an error occurs
|
|
2721
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2641
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateDynamicGroup.ts.html |here} to see how to use UpdateDynamicGroup API.
|
|
2722
2642
|
*/
|
|
2723
2643
|
updateDynamicGroup(updateDynamicGroupRequest: requests.UpdateDynamicGroupRequest): Promise<responses.UpdateDynamicGroupResponse>;
|
|
2724
2644
|
/**
|
|
2725
2645
|
* Updates the specified group.
|
|
2726
|
-
* This operation
|
|
2646
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2727
2647
|
* @param UpdateGroupRequest
|
|
2728
2648
|
* @return UpdateGroupResponse
|
|
2729
2649
|
* @throws OciError when an error occurs
|
|
2730
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2650
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateGroup.ts.html |here} to see how to use UpdateGroup API.
|
|
2731
2651
|
*/
|
|
2732
2652
|
updateGroup(updateGroupRequest: requests.UpdateGroupRequest): Promise<responses.UpdateGroupResponse>;
|
|
2733
2653
|
/**
|
|
@@ -2735,11 +2655,11 @@ export declare class IdentityClient {
|
|
|
2735
2655
|
* <p>
|
|
2736
2656
|
Updates the specified identity provider.
|
|
2737
2657
|
*
|
|
2738
|
-
* This operation
|
|
2658
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2739
2659
|
* @param UpdateIdentityProviderRequest
|
|
2740
2660
|
* @return UpdateIdentityProviderResponse
|
|
2741
2661
|
* @throws OciError when an error occurs
|
|
2742
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2662
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateIdentityProvider.ts.html |here} to see how to use UpdateIdentityProvider API.
|
|
2743
2663
|
*/
|
|
2744
2664
|
updateIdentityProvider(updateIdentityProviderRequest: requests.UpdateIdentityProviderRequest): Promise<responses.UpdateIdentityProviderResponse>;
|
|
2745
2665
|
/**
|
|
@@ -2747,30 +2667,31 @@ export declare class IdentityClient {
|
|
|
2747
2667
|
* <p>
|
|
2748
2668
|
Updates the specified group mapping.
|
|
2749
2669
|
*
|
|
2750
|
-
* This operation
|
|
2670
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2751
2671
|
* @param UpdateIdpGroupMappingRequest
|
|
2752
2672
|
* @return UpdateIdpGroupMappingResponse
|
|
2753
2673
|
* @throws OciError when an error occurs
|
|
2754
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2674
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateIdpGroupMapping.ts.html |here} to see how to use UpdateIdpGroupMapping API.
|
|
2755
2675
|
*/
|
|
2756
2676
|
updateIdpGroupMapping(updateIdpGroupMappingRequest: requests.UpdateIdpGroupMappingRequest): Promise<responses.UpdateIdpGroupMappingResponse>;
|
|
2757
2677
|
/**
|
|
2758
2678
|
* Updates the specified network source.
|
|
2759
|
-
*
|
|
2679
|
+
*
|
|
2680
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2760
2681
|
* @param UpdateNetworkSourceRequest
|
|
2761
2682
|
* @return UpdateNetworkSourceResponse
|
|
2762
2683
|
* @throws OciError when an error occurs
|
|
2763
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2684
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateNetworkSource.ts.html |here} to see how to use UpdateNetworkSource API.
|
|
2764
2685
|
*/
|
|
2765
2686
|
updateNetworkSource(updateNetworkSourceRequest: requests.UpdateNetworkSourceRequest): Promise<responses.UpdateNetworkSourceResponse>;
|
|
2766
2687
|
/**
|
|
2767
2688
|
* Updates Oauth token for the user
|
|
2768
2689
|
*
|
|
2769
|
-
* This operation
|
|
2690
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2770
2691
|
* @param UpdateOAuthClientCredentialRequest
|
|
2771
2692
|
* @return UpdateOAuthClientCredentialResponse
|
|
2772
2693
|
* @throws OciError when an error occurs
|
|
2773
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2694
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateOAuthClientCredential.ts.html |here} to see how to use UpdateOAuthClientCredential API.
|
|
2774
2695
|
*/
|
|
2775
2696
|
updateOAuthClientCredential(updateOAuthClientCredentialRequest: requests.UpdateOAuthClientCredentialRequest): Promise<responses.UpdateOAuthClientCredentialResponse>;
|
|
2776
2697
|
/**
|
|
@@ -2778,21 +2699,21 @@ export declare class IdentityClient {
|
|
|
2778
2699
|
* <p>
|
|
2779
2700
|
Policy changes take effect typically within 10 seconds.
|
|
2780
2701
|
*
|
|
2781
|
-
* This operation
|
|
2702
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2782
2703
|
* @param UpdatePolicyRequest
|
|
2783
2704
|
* @return UpdatePolicyResponse
|
|
2784
2705
|
* @throws OciError when an error occurs
|
|
2785
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2706
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdatePolicy.ts.html |here} to see how to use UpdatePolicy API.
|
|
2786
2707
|
*/
|
|
2787
2708
|
updatePolicy(updatePolicyRequest: requests.UpdatePolicyRequest): Promise<responses.UpdatePolicyResponse>;
|
|
2788
2709
|
/**
|
|
2789
2710
|
* Updates the specified SMTP credential's description.
|
|
2790
2711
|
*
|
|
2791
|
-
* This operation
|
|
2712
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2792
2713
|
* @param UpdateSmtpCredentialRequest
|
|
2793
2714
|
* @return UpdateSmtpCredentialResponse
|
|
2794
2715
|
* @throws OciError when an error occurs
|
|
2795
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2716
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateSmtpCredential.ts.html |here} to see how to use UpdateSmtpCredential API.
|
|
2796
2717
|
*/
|
|
2797
2718
|
updateSmtpCredential(updateSmtpCredentialRequest: requests.UpdateSmtpCredentialRequest): Promise<responses.UpdateSmtpCredentialResponse>;
|
|
2798
2719
|
/**
|
|
@@ -2800,11 +2721,11 @@ export declare class IdentityClient {
|
|
|
2800
2721
|
* <p>
|
|
2801
2722
|
Updates the specified Swift password's description.
|
|
2802
2723
|
*
|
|
2803
|
-
* This operation
|
|
2724
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2804
2725
|
* @param UpdateSwiftPasswordRequest
|
|
2805
2726
|
* @return UpdateSwiftPasswordResponse
|
|
2806
2727
|
* @throws OciError when an error occurs
|
|
2807
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2728
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateSwiftPassword.ts.html |here} to see how to use UpdateSwiftPassword API.
|
|
2808
2729
|
*/
|
|
2809
2730
|
updateSwiftPassword(updateSwiftPasswordRequest: requests.UpdateSwiftPasswordRequest): Promise<responses.UpdateSwiftPasswordResponse>;
|
|
2810
2731
|
/**
|
|
@@ -2819,11 +2740,11 @@ export declare class IdentityClient {
|
|
|
2819
2740
|
You cannot remove list values that appear in a TagDefault. To remove a list value that
|
|
2820
2741
|
* appears in a TagDefault, first update the TagDefault to use a different value.
|
|
2821
2742
|
*
|
|
2822
|
-
* This operation
|
|
2743
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2823
2744
|
* @param UpdateTagRequest
|
|
2824
2745
|
* @return UpdateTagResponse
|
|
2825
2746
|
* @throws OciError when an error occurs
|
|
2826
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2747
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateTag.ts.html |here} to see how to use UpdateTag API.
|
|
2827
2748
|
*/
|
|
2828
2749
|
updateTag(updateTagRequest: requests.UpdateTagRequest): Promise<responses.UpdateTagResponse>;
|
|
2829
2750
|
/**
|
|
@@ -2834,11 +2755,11 @@ export declare class IdentityClient {
|
|
|
2834
2755
|
* If the `isRequired` flag is set to \"true\", the value is set during resource creation.
|
|
2835
2756
|
* * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.
|
|
2836
2757
|
*
|
|
2837
|
-
* This operation
|
|
2758
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2838
2759
|
* @param UpdateTagDefaultRequest
|
|
2839
2760
|
* @return UpdateTagDefaultResponse
|
|
2840
2761
|
* @throws OciError when an error occurs
|
|
2841
|
-
* @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.24.0/identity/UpdateTagDefault.ts.html |here} to see how to use UpdateTagDefault API.
|
|
2842
2763
|
*/
|
|
2843
2764
|
updateTagDefault(updateTagDefaultRequest: requests.UpdateTagDefaultRequest): Promise<responses.UpdateTagDefaultResponse>;
|
|
2844
2765
|
/**
|
|
@@ -2848,44 +2769,44 @@ export declare class IdentityClient {
|
|
|
2848
2769
|
* namespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions.
|
|
2849
2770
|
* To reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace,
|
|
2850
2771
|
* using {@link #updateTag(UpdateTagRequest) updateTag}. For more information about retiring tag namespaces, see
|
|
2851
|
-
* [Retiring Key Definitions and Namespace Definitions](https://docs.cloud.oracle.com/Content/
|
|
2772
|
+
* [Retiring Key Definitions and Namespace Definitions](https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
|
|
2852
2773
|
* <p>
|
|
2853
2774
|
You can't add a namespace with the same name as a retired namespace in the same tenancy.
|
|
2854
2775
|
*
|
|
2855
|
-
* This operation
|
|
2776
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2856
2777
|
* @param UpdateTagNamespaceRequest
|
|
2857
2778
|
* @return UpdateTagNamespaceResponse
|
|
2858
2779
|
* @throws OciError when an error occurs
|
|
2859
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2780
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateTagNamespace.ts.html |here} to see how to use UpdateTagNamespace API.
|
|
2860
2781
|
*/
|
|
2861
2782
|
updateTagNamespace(updateTagNamespaceRequest: requests.UpdateTagNamespaceRequest): Promise<responses.UpdateTagNamespaceResponse>;
|
|
2862
2783
|
/**
|
|
2863
2784
|
* Updates the description of the specified user.
|
|
2864
|
-
* This operation
|
|
2785
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2865
2786
|
* @param UpdateUserRequest
|
|
2866
2787
|
* @return UpdateUserResponse
|
|
2867
2788
|
* @throws OciError when an error occurs
|
|
2868
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2789
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateUser.ts.html |here} to see how to use UpdateUser API.
|
|
2869
2790
|
*/
|
|
2870
2791
|
updateUser(updateUserRequest: requests.UpdateUserRequest): Promise<responses.UpdateUserResponse>;
|
|
2871
2792
|
/**
|
|
2872
2793
|
* Updates the capabilities of the specified user.
|
|
2873
2794
|
*
|
|
2874
|
-
* This operation
|
|
2795
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2875
2796
|
* @param UpdateUserCapabilitiesRequest
|
|
2876
2797
|
* @return UpdateUserCapabilitiesResponse
|
|
2877
2798
|
* @throws OciError when an error occurs
|
|
2878
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2799
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateUserCapabilities.ts.html |here} to see how to use UpdateUserCapabilities API.
|
|
2879
2800
|
*/
|
|
2880
2801
|
updateUserCapabilities(updateUserCapabilitiesRequest: requests.UpdateUserCapabilitiesRequest): Promise<responses.UpdateUserCapabilitiesResponse>;
|
|
2881
2802
|
/**
|
|
2882
2803
|
* Updates the state of the specified user.
|
|
2883
2804
|
*
|
|
2884
|
-
* This operation
|
|
2805
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2885
2806
|
* @param UpdateUserStateRequest
|
|
2886
2807
|
* @return UpdateUserStateResponse
|
|
2887
2808
|
* @throws OciError when an error occurs
|
|
2888
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2809
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UpdateUserState.ts.html |here} to see how to use UpdateUserState API.
|
|
2889
2810
|
*/
|
|
2890
2811
|
updateUserState(updateUserStateRequest: requests.UpdateUserStateRequest): Promise<responses.UpdateUserStateResponse>;
|
|
2891
2812
|
/**
|
|
@@ -2905,11 +2826,11 @@ export declare class IdentityClient {
|
|
|
2905
2826
|
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using
|
|
2906
2827
|
* the object, first make sure its `lifecycleState` has changed to ACTIVE.
|
|
2907
2828
|
*
|
|
2908
|
-
* This operation
|
|
2829
|
+
* This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
|
|
2909
2830
|
* @param UploadApiKeyRequest
|
|
2910
2831
|
* @return UploadApiKeyResponse
|
|
2911
2832
|
* @throws OciError when an error occurs
|
|
2912
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
2833
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.24.0/identity/UploadApiKey.ts.html |here} to see how to use UploadApiKey API.
|
|
2913
2834
|
*/
|
|
2914
2835
|
uploadApiKey(uploadApiKeyRequest: requests.UploadApiKeyRequest): Promise<responses.UploadApiKeyResponse>;
|
|
2915
2836
|
}
|