Interface Identity

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.
      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)
      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.
      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.
      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
      • activateDomain

        ActivateDomainResponse activateDomain​(ActivateDomainRequest request)
        (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.

        After you send the request, the `lifecycleDetails` of the identity domain is set to ACTIVATING. When the operation completes, the `lifecycleDetails` is set to null and the `lifecycleState` of the identity domain is set to ACTIVE.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ActivateDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ActivateDomain API.

      • activateMfaTotpDevice

        ActivateMfaTotpDeviceResponse activateMfaTotpDevice​(ActivateMfaTotpDeviceRequest request)
        Activates the specified MFA TOTP device for the user.

        Activation requires manual interaction with the Console.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ActivateMfaTotpDeviceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ActivateMfaTotpDevice API.

      • addTagDefaultLock

        AddTagDefaultLockResponse addTagDefaultLock​(AddTagDefaultLockRequest request)
        Add a resource lock to a tag default.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/AddTagDefaultLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddTagDefaultLock API.

      • addTagNamespaceLock

        AddTagNamespaceLockResponse addTagNamespaceLock​(AddTagNamespaceLockRequest request)
        Add a resource lock to a tag namespace.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/AddTagNamespaceLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddTagNamespaceLock API.

      • addUserToGroup

        AddUserToGroupResponse addUserToGroup​(AddUserToGroupRequest request)
        Adds the specified user to the specified group and returns a UserGroupMembership object with its own OCID.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/AddUserToGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddUserToGroup API.

      • assembleEffectiveTagSet

        AssembleEffectiveTagSetResponse assembleEffectiveTagSet​(AssembleEffectiveTagSetRequest request)
        Assembles tag defaults in the specified compartment and any parent compartments to determine the tags to apply.

        Tag defaults from parent compartments do not override tag defaults referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults includes all tag defaults from the current compartment back to the root compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/AssembleEffectiveTagSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AssembleEffectiveTagSet API.

      • bulkDeleteResources

        BulkDeleteResourcesResponse bulkDeleteResources​(BulkDeleteResourcesRequest request)
        Deletes multiple resources in the compartment.

        All resources must be in the same compartment. You must have the appropriate permissions to delete the resources in the request. This API can only be invoked from the tenancy’s home region. This operation creates a WorkRequest. Use the getWorkRequest API to monitor the status of the bulk action.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/BulkDeleteResourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkDeleteResources API.

      • bulkDeleteTags

        BulkDeleteTagsResponse bulkDeleteTags​(BulkDeleteTagsRequest request)
        Deletes the specified tag key definitions.

        This operation triggers a process that removes the tags from all resources in your tenancy. The tag key definitions must be within the same tag namespace.

        The following actions happen immediately:

        If the tag is a cost-tracking tag, the tag no longer counts against your 10 cost-tracking tags limit, even if you do not disable the tag before running this operation. * If the tag is used with dynamic groups, the rules that contain the tag are no longer evaluated against the tag.

        After you start this operation, the state of the tag changes to DELETING, and tag removal from resources begins. This process can take up to 48 hours depending on the number of resources that are tagged and the regions in which those resources reside.

        When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state changes to DELETED, you can use the same tag name again.

        After you start this operation, you cannot start either the deleteTag or the cascadeDeleteTagNamespace operation until this process completes.

        In order to delete tags, you must first retire the tags. Use updateTag to retire a tag.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/BulkDeleteTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkDeleteTags API.

      • bulkEditTags

        BulkEditTagsResponse bulkEditTags​(BulkEditTagsRequest request)
        Edits the specified list of tag key definitions for the selected resources.

        This operation triggers a process that edits the tags on all selected resources. The possible actions are:

        Add a defined tag when the tag does not already exist on the resource. * Update the value for a defined tag when the tag is present on the resource. * Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource. * Remove a defined tag from a resource. The tag is removed from the resource regardless of the tag value.

        See bulkEditOperationDetails for more information.

        The edits can include a combination of operations and tag sets. However, multiple operations cannot apply to one key definition in the same request. For example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`, `tag set-1` and `tag set-2` cannot have any common tag definitions.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/BulkEditTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkEditTags API.

      • bulkMoveResources

        BulkMoveResourcesResponse bulkMoveResources​(BulkMoveResourcesRequest request)
        Moves multiple resources from one compartment to another.

        All resources must be in the same compartment. This API can only be invoked from the tenancy’s home region. To move resources, you must have the appropriate permissions to move the resource in both the source and target compartments. This operation creates a WorkRequest. Use the getWorkRequest API to monitor the status of the bulk action.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/BulkMoveResourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BulkMoveResources API.

      • cascadeDeleteTagNamespace

        CascadeDeleteTagNamespaceResponse cascadeDeleteTagNamespace​(CascadeDeleteTagNamespaceRequest request)
        Deletes the specified tag namespace.

        This operation triggers a process that removes all of the tags defined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace.

        After you start the delete operation:

        New tag key definitions cannot be created under the namespace. * The state of the tag namespace changes to DELETING. * Tag removal from the resources begins.

        This process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources that are tagged, and the locations of the regions in which those resources reside.

        After all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace changes its state to DELETED, you can use the name of the deleted tag namespace again.

        After you start this operation, you cannot start either the deleteTag or the bulkDeleteTags operation until this process completes.

        To delete a tag namespace, you must first retire it. Use updateTagNamespace to retire a tag namespace.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CascadeDeleteTagNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CascadeDeleteTagNamespace API.

      • changeDomainCompartment

        ChangeDomainCompartmentResponse changeDomainCompartment​(ChangeDomainCompartmentRequest request)
        (For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ChangeDomainCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDomainCompartment API.

      • changeDomainLicenseType

        ChangeDomainLicenseTypeResponse changeDomainLicenseType​(ChangeDomainLicenseTypeRequest request)
        (For tenancies that support identity domains) Changes the license type of the given identity domain.

        The identity domain’s lifecycleState must be set to ACTIVE and the requested licenseType must be allowed. To retrieve the allowed licenseType for the identity domain, use listAllowedDomainLicenseTypes.

        After you send your request, the `lifecycleDetails` of this identity domain is set to UPDATING. When the update of the identity domain completes, then the `lifecycleDetails` is set to null.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ChangeDomainLicenseTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDomainLicenseType API.

      • changeTagNamespaceCompartment

        ChangeTagNamespaceCompartmentResponse changeTagNamespaceCompartment​(ChangeTagNamespaceCompartmentRequest request)
        Moves the specified tag namespace to the specified compartment within the same tenancy.

        To move the tag namespace, you must have the manage tag-namespaces permission on both compartments. For more information about IAM policies, see [Details for IAM](https://docs.oracle.com/iaas/Content/Identity/policyreference/iampolicyreference.htm).

        Moving a tag namespace moves all the tag key definitions contained in the tag namespace.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ChangeTagNamespaceCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeTagNamespaceCompartment API.

      • createAuthToken

        CreateAuthTokenResponse createAuthToken​(CreateAuthTokenRequest request)
        Creates a new auth token for the specified user.

        For information about what auth tokens are for, see Managing User Credentials.

        You must specify a *description* for the auth token (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateAuthToken.

        Every user has permission to create an auth token for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create an auth token for any user, including themselves.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateAuthTokenExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateAuthToken API.

      • createCompartment

        CreateCompartmentResponse createCompartment​(CreateCompartmentRequest request)
        Creates a new compartment in the specified compartment.

        Specify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        You must also specify a *name* for the compartment, which must be unique across all compartments in your tenancy. You can use this name or the OCID when writing policies that apply to the compartment. For more information about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm).

        You must also specify a *description* for the compartment (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateCompartment.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCompartment API.

      • createCustomerSecretKey

        CreateCustomerSecretKeyResponse createCustomerSecretKey​(CreateCustomerSecretKeyRequest request)
        Creates a new secret key for the specified user.

        Secret keys are used for authentication with the Object Storage Service’s Amazon S3 compatible API. The secret key consists of an Access Key/Secret Key pair. For information, see Managing User Credentials.

        You must specify a *description* for the secret key (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateCustomerSecretKey.

        Every user has permission to create a secret key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a secret key for any user, including themselves.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateCustomerSecretKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCustomerSecretKey API.

      • createDbCredential

        CreateDbCredentialResponse createDbCredential​(CreateDbCredentialRequest request)
        Creates a new DB credential for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateDbCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDbCredential API.

      • createDomain

        CreateDomainResponse createDomain​(CreateDomainRequest request)
        (For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in homeRegion.

        After you send your request, the temporary lifecycleState of this identity domain is set to CREATING and lifecycleDetails to UPDATING. When creation of the identity domain completes, this identity domain’s lifecycleState is set to ACTIVE and lifecycleDetails to null.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        After creating an `identity domain`, first make sure its `lifecycleState` changes from CREATING to ACTIVE before you use it.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDomain API.

      • createDynamicGroup

        CreateDynamicGroupResponse createDynamicGroup​(CreateDynamicGroupRequest request)
        Creates a new dynamic group in your tenancy.

        You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        You must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. You can use this name or the OCID when writing policies that apply to the dynamic group. For more information about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm).

        You must also specify a *description* for the dynamic group (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateDynamicGroup.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateDynamicGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDynamicGroup API.

      • createGroup

        CreateGroupResponse createGroup​(CreateGroupRequest request)
        Creates a new group in your tenancy.

        You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        You must also specify a *name* for the group, which must be unique across all groups in your tenancy and cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more information about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm).

        You must also specify a *description* for the group (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateGroup.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        After creating the group, you need to put users in it and write policies for it. See addUserToGroup and createPolicy.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateGroup API.

      • createIdentityProvider

        CreateIdentityProviderResponse createIdentityProvider​(CreateIdentityProviderRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Creates a new identity provider in your tenancy. For more information, see [Identity Providers and Federation](https://docs.oracle.com/iaas/Content/Identity/Concepts/federation.htm).

        You must specify your tenancy's OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        You must also specify a *name* for the `IdentityProvider`, which must be unique across all `IdentityProvider` objects in your tenancy and cannot be changed.

        You must also specify a *description* for the `IdentityProvider` (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateIdentityProvider.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateIdentityProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateIdentityProvider API.

      • createIdpGroupMapping

        CreateIdpGroupMappingResponse createIdpGroupMapping​(CreateIdpGroupMappingRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Creates a single mapping between an IdP group and an IAM Service Group.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateIdpGroupMappingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateIdpGroupMapping API.

      • createMfaTotpDevice

        CreateMfaTotpDeviceResponse createMfaTotpDevice​(CreateMfaTotpDeviceRequest request)
        Creates a new MFA TOTP device for the user.

        A user can have one MFA TOTP device.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateMfaTotpDeviceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateMfaTotpDevice API.

      • createNetworkSource

        CreateNetworkSourceResponse createNetworkSource​(CreateNetworkSourceRequest request)
        Creates a new network source in your tenancy.

        You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        You must also specify a *name* for the network source, which must be unique across all network sources in your tenancy, and cannot be changed. You can use this name or the OCID when writing policies that apply to the network source. For more information about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm).

        You must also specify a *description* for the network source (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateNetworkSource.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed IP address specified in your network source. For more information, see [Managing Network Sources](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateNetworkSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateNetworkSource API.

      • createOAuthClientCredential

        CreateOAuthClientCredentialResponse createOAuthClientCredential​(CreateOAuthClientCredentialRequest request)
        Creates Oauth token for the user
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateOAuthClientCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOAuthClientCredential API.

      • createOrResetUIPassword

        CreateOrResetUIPasswordResponse createOrResetUIPassword​(CreateOrResetUIPasswordRequest request)
        Creates a new Console one-time password for the specified user.

        For more information about user credentials, see User Credentials.

        Use this operation after creating a new user, or if a user forgets their password. The new one-time password is returned to you in the response, and you must securely deliver it to the user. They'll be prompted to change this password the next time they sign in to the Console. If they don't change it within 7 days, the password will expire and you'll need to create a new one-time password for the user.

        (For tenancies that support identity domains) Resetting a user's password generates a reset password email with a link that the user must follow to reset their password. If the user does not reset their password before the link expires, you'll need to reset the user's password again.

        *Note:** The user's Console login is the unique name you specified when you created the user (see createUser).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateOrResetUIPasswordExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOrResetUIPassword API.

      • createPolicy

        CreatePolicyResponse createPolicy​(CreatePolicyRequest request)
        Creates a new policy in the specified compartment (either the tenancy or another of your compartments).

        If you’re new to policies, see Get Started with Policies.

        You must specify a *name* for the policy, which must be unique across all policies in your tenancy and cannot be changed.

        You must also specify a *description* for the policy (although it can be an empty string). It does not have to be unique, and you can change it anytime with updatePolicy.

        You must specify one or more policy statements in the statements array. For information about writing policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm) and [Common Policies](https://docs.oracle.com/iaas/Content/Identity/policiescommon/commonpolicies.htm).

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        New policies take effect typically within 10 seconds.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreatePolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePolicy API.

      • createRegionSubscription

        CreateRegionSubscriptionResponse createRegionSubscription​(CreateRegionSubscriptionRequest request)
        Creates a subscription to a region for a tenancy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateRegionSubscriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateRegionSubscription API.

      • createSmtpCredential

        CreateSmtpCredentialResponse createSmtpCredential​(CreateSmtpCredentialRequest request)
        Creates a new SMTP credential for the specified user.

        An SMTP credential has an SMTP user name and an SMTP password. You must specify a description for the SMTP credential (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateSmtpCredential.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateSmtpCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSmtpCredential API.

      • createSwiftPassword

        CreateSwiftPasswordResponse createSwiftPassword​(CreateSwiftPasswordRequest request)
        **Deprecated.

        Use createAuthToken instead.**

        Creates a new Swift password for the specified user. For information about what Swift passwords are for, see [Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).

        You must specify a *description* for the Swift password (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateSwiftPassword.

        Every user has permission to create a Swift password for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a Swift password for any user, including themselves.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateSwiftPasswordExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSwiftPassword API.

      • createTag

        CreateTagResponse createTag​(CreateTagRequest request)
        Creates a new tag in the specified tag namespace.

        The tag requires either the OCID or the name of the tag namespace that will contain this tag definition.

        You must specify a *name* for the tag, which must be unique across all tags in the tag namespace and cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters. Names are case insensitive. That means, for example, \"myTag\" and \"mytag\" are not allowed in the same namespace. If you specify a name that's already in use in the tag namespace, a 409 error is returned.

        The tag must have a *description*. It does not have to be unique, and you can change it with updateTag.

        The tag must have a value type, which is specified with a validator. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. Lists are validiated.

        If no `validator` is set, the user applying the tag to a resource can type in a static value or leave the tag value empty. * If a `validator` is set, the user applying the tag to a resource must select from a list of values that you supply with enumTagDefinitionValidator.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTag API.

      • createTagDefault

        CreateTagDefaultResponse createTagDefault​(CreateTagDefaultRequest request)
        Creates a new tag default in the specified compartment for the specified tag definition.

        If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

        If the `isRequired` flag is set to \"true\", the value is set during resource creation. * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateTagDefaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTagDefault API.

      • createTagNamespace

        CreateTagNamespaceResponse createTagNamespace​(CreateTagNamespaceRequest request)
        Creates a new tag namespace in the specified compartment.

        You must specify the compartment ID in the request object (remember that the tenancy is simply the root compartment).

        You must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy and cannot be changed. The name can contain any ASCII character except the space (_) or period (.). Names are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed in the same tenancy. Once you created a namespace, you cannot change the name. If you specify a name that's already in use in the tenancy, a 409 error is returned.

        You must also specify a *description* for the namespace. It does not have to be unique, and you can change it with updateTagNamespace.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateTagNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTagNamespace API.

      • createUser

        CreateUserResponse createUser​(CreateUserRequest request)
        Creates a new user in your tenancy.

        For conceptual information about users, your tenancy, and other IAM Service components, see Overview of IAM.

        You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

        You must also specify a *name* for the user, which must be unique across all users in your tenancy and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, underscores, +, and @. If you specify a name that's already in use, you'll get a 409 error. This name will be the user's login to the Console. You might want to pick a name that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses. If you delete a user and then create a new user with the same name, they'll be considered different users because they have different OCIDs.

        You must also specify a *description* for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with updateUser. You can use the field to provide the user's full name, a description, a nickname, or other information to generally identify the user.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        A new user has no permissions until you place the user in one or more groups (see addUserToGroup). If the user needs to access the Console, you need to provide the user a password (see createOrResetUIPassword). If the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a public API signing key for that user (see [Required Keys and OCIDs](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm) and also uploadApiKey).

        *Important:** Make sure to inform the new user which compartment(s) they have access to.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/CreateUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateUser API.

      • deactivateDomain

        DeactivateDomainResponse deactivateDomain​(DeactivateDomainRequest request)
        (For tenancies that support identity domains) Deactivates the specified identity domain.

        Identity domains must be in an ACTIVE lifecycleState and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate the default identity domain.

        After you send your request, the `lifecycleDetails` of this identity domain is set to DEACTIVATING. When the operation completes, then the `lifecycleDetails` is set to null and the `lifecycleState` is set to INACTIVE.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeactivateDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeactivateDomain API.

      • deleteApiKey

        DeleteApiKeyResponse deleteApiKey​(DeleteApiKeyRequest request)
        Deletes the specified API signing key for the specified user.

        Every user has permission to use this operation to delete a key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to delete a key for any user, including themselves.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteApiKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteApiKey API.

      • deleteAuthToken

        DeleteAuthTokenResponse deleteAuthToken​(DeleteAuthTokenRequest request)
        Deletes the specified auth token for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteAuthTokenExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteAuthToken API.

      • deleteCompartment

        DeleteCompartmentResponse deleteCompartment​(DeleteCompartmentRequest request)
        Deletes the specified compartment.

        The compartment must be empty.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCompartment API.

      • deleteCustomerSecretKey

        DeleteCustomerSecretKeyResponse deleteCustomerSecretKey​(DeleteCustomerSecretKeyRequest request)
        Deletes the specified secret key for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteCustomerSecretKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCustomerSecretKey API.

      • deleteDbCredential

        DeleteDbCredentialResponse deleteDbCredential​(DeleteDbCredentialRequest request)
        Deletes the specified DB credential for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteDbCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDbCredential API.

      • deleteDomain

        DeleteDomainResponse deleteDomain​(DeleteDomainRequest request)
        (For tenancies that support identity domains) Deletes an identity domain.

        The identity domain must have no active apps present in the underlying IDCS stripe. You must also deactivate the identity domain, rendering the lifecycleState of the identity domain INACTIVE. Furthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting. Lastly, you cannot delete the default identity domain. A tenancy must always have at least the default identity domain.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDomain API.

      • deleteDynamicGroup

        DeleteDynamicGroupResponse deleteDynamicGroup​(DeleteDynamicGroupRequest request)
        Deletes the specified dynamic group.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteDynamicGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDynamicGroup API.

      • deleteGroup

        DeleteGroupResponse deleteGroup​(DeleteGroupRequest request)
        Deletes the specified group.

        The group must be empty.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteGroup API.

      • deleteIdentityProvider

        DeleteIdentityProviderResponse deleteIdentityProvider​(DeleteIdentityProviderRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Deletes the specified identity provider. The identity provider must not have any group mappings (see IdpGroupMapping).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteIdentityProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteIdentityProvider API.

      • deleteIdpGroupMapping

        DeleteIdpGroupMappingResponse deleteIdpGroupMapping​(DeleteIdpGroupMappingRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Deletes the specified group mapping.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteIdpGroupMappingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteIdpGroupMapping API.

      • deleteMfaTotpDevice

        DeleteMfaTotpDeviceResponse deleteMfaTotpDevice​(DeleteMfaTotpDeviceRequest request)
        Deletes the specified MFA TOTP device for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteMfaTotpDeviceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteMfaTotpDevice API.

      • deleteNetworkSource

        DeleteNetworkSourceResponse deleteNetworkSource​(DeleteNetworkSourceRequest request)
        Deletes the specified network source.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteNetworkSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteNetworkSource API.

      • deleteOAuthClientCredential

        DeleteOAuthClientCredentialResponse deleteOAuthClientCredential​(DeleteOAuthClientCredentialRequest request)
        Delete Oauth token for the user
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteOAuthClientCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOAuthClientCredential API.

      • deletePolicy

        DeletePolicyResponse deletePolicy​(DeletePolicyRequest request)
        Deletes the specified policy.

        The deletion takes effect typically within 10 seconds.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeletePolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePolicy API.

      • deleteSmtpCredential

        DeleteSmtpCredentialResponse deleteSmtpCredential​(DeleteSmtpCredentialRequest request)
        Deletes the specified SMTP credential for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteSmtpCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSmtpCredential API.

      • deleteSwiftPassword

        DeleteSwiftPasswordResponse deleteSwiftPassword​(DeleteSwiftPasswordRequest request)
        **Deprecated.

        Use deleteAuthToken instead.**

        Deletes the specified Swift password for the specified user.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteSwiftPasswordExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSwiftPassword API.

      • deleteTag

        DeleteTagResponse deleteTag​(DeleteTagRequest request)
        Deletes the specified tag definition.

        This operation triggers a process that removes the tag from all resources in your tenancy.

        These things happen immediately: * If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking tags limit, whether you first disabled it or not. * If the tag was used with dynamic groups, none of the rules that contain the tag will be evaluated against the tag.

        When you start the delete operation, the state of the tag changes to DELETING and tag removal from resources begins. This can take up to 48 hours depending on the number of resources that were tagged as well as the regions in which those resources reside.

        When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag changes its state to DELETED, you can use the same tag name again.

        After you start this operation, you cannot start either the bulkDeleteTags or the cascadeDeleteTagNamespace operation until this process completes.

        To delete a tag, you must first retire it. Use updateTag to retire a tag.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTag API.

      • deleteTagDefault

        DeleteTagDefaultResponse deleteTagDefault​(DeleteTagDefaultRequest request)
        Deletes the the specified tag default.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteTagDefaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTagDefault API.

      • deleteTagNamespace

        DeleteTagNamespaceResponse deleteTagNamespace​(DeleteTagNamespaceRequest request)
        Deletes the specified tag namespace.

        Only an empty tag namespace can be deleted with this operation. To use this operation to delete a tag namespace that contains tag definitions, first delete all of its tag definitions.

        Use cascadeDeleteTagNamespace to delete a tag namespace along with all of the tag definitions contained within that namespace.

        Use deleteTag to delete a tag definition.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteTagNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTagNamespace API.

      • deleteUser

        DeleteUserResponse deleteUser​(DeleteUserRequest request)
        Deletes the specified user.

        The user must not be in any groups.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/DeleteUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUser API.

      • enableReplicationToRegion

        EnableReplicationToRegionResponse enableReplicationToRegion​(EnableReplicationToRegionRequest request)
        (For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the tenancy home region or other region that the tenancy subscribes to).

        You can only replicate identity domains that are in an ACTIVE lifecycleState and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains. The default identity domain is automatically replicated to all regions that the tenancy subscribes to.

        After you send the request, the `state` of the identity domain in the replica region is set to ENABLING_REPLICATION. When the operation completes, the `state` is set to REPLICATION_ENABLED.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/EnableReplicationToRegionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EnableReplicationToRegion API.

      • generateTotpSeed

        GenerateTotpSeedResponse generateTotpSeed​(GenerateTotpSeedRequest request)
        Generate seed for the MFA TOTP device.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GenerateTotpSeedExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GenerateTotpSeed API.

      • getAuthenticationPolicy

        GetAuthenticationPolicyResponse getAuthenticationPolicy​(GetAuthenticationPolicyRequest request)
        Gets the authentication policy for the given tenancy.

        You must specify your tenant’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetAuthenticationPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAuthenticationPolicy API.

      • getCompartment

        GetCompartmentResponse getCompartment​(GetCompartmentRequest request)
        Gets the specified compartment’s information.

        This operation does not return a list of all the resources inside the compartment. There is no single API operation that does that. Compartments can contain multiple types of resources (instances, block storage volumes, etc.). To find out what's in a compartment, you must call the \"List\" operation for each resource type and specify the compartment's OCID as a query parameter in the request. For example, call the listInstances operation in the Cloud Compute Service or the listVolumes operation in Cloud Block Storage.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCompartment API.

      • getDomain

        GetDomainResponse getDomain​(GetDomainRequest request)
        (For tenancies that support identity domains) Gets the specified identity domain’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDomain API.

      • getDynamicGroup

        GetDynamicGroupResponse getDynamicGroup​(GetDynamicGroupRequest request)
        Gets the specified dynamic group’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetDynamicGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDynamicGroup API.

      • getGroup

        GetGroupResponse getGroup​(GetGroupRequest request)
        Gets the specified group’s information.

        This operation does not return a list of all the users in the group. To do that, use listUserGroupMemberships and provide the group's OCID as a query parameter in the request.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGroup API.

      • getIamWorkRequest

        GetIamWorkRequestResponse getIamWorkRequest​(GetIamWorkRequestRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetIamWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetIamWorkRequest API.

      • getIdentityProvider

        GetIdentityProviderResponse getIdentityProvider​(GetIdentityProviderRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Gets the specified identity provider's information.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetIdentityProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetIdentityProvider API.

      • getIdpGroupMapping

        GetIdpGroupMappingResponse getIdpGroupMapping​(GetIdpGroupMappingRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Gets the specified group mapping.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetIdpGroupMappingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetIdpGroupMapping API.

      • getMfaTotpDevice

        GetMfaTotpDeviceResponse getMfaTotpDevice​(GetMfaTotpDeviceRequest request)
        Get the specified MFA TOTP device for the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetMfaTotpDeviceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMfaTotpDevice API.

      • getNetworkSource

        GetNetworkSourceResponse getNetworkSource​(GetNetworkSourceRequest request)
        Gets the specified network source’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetNetworkSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetNetworkSource API.

      • getPolicy

        GetPolicyResponse getPolicy​(GetPolicyRequest request)
        Gets the specified policy’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPolicy API.

      • getStandardTagTemplate

        GetStandardTagTemplateResponse getStandardTagTemplate​(GetStandardTagTemplateRequest request)
        Retrieve the standard tag namespace template given the standard tag namespace name.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetStandardTagTemplateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStandardTagTemplate API.

      • getTag

        GetTagResponse getTag​(GetTagRequest request)
        Gets the specified tag’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTag API.

      • getTagDefault

        GetTagDefaultResponse getTagDefault​(GetTagDefaultRequest request)
        Retrieves the specified tag default.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetTagDefaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTagDefault API.

      • getTagNamespace

        GetTagNamespaceResponse getTagNamespace​(GetTagNamespaceRequest request)
        Gets the specified tag namespace’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetTagNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTagNamespace API.

      • getTaggingWorkRequest

        GetTaggingWorkRequestResponse getTaggingWorkRequest​(GetTaggingWorkRequestRequest request)
        Gets details on a specified work request.

        The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in tagging service.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetTaggingWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTaggingWorkRequest API.

      • getTenancy

        GetTenancyResponse getTenancy​(GetTenancyRequest request)
        Get the specified tenancy’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetTenancyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTenancy API.

      • getUser

        GetUserResponse getUser​(GetUserRequest request)
        Gets the specified user’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUser API.

      • getUserGroupMembership

        GetUserGroupMembershipResponse getUserGroupMembership​(GetUserGroupMembershipRequest request)
        Gets the specified UserGroupMembership’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetUserGroupMembershipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUserGroupMembership API.

      • getUserUIPasswordInformation

        GetUserUIPasswordInformationResponse getUserUIPasswordInformation​(GetUserUIPasswordInformationRequest request)
        Gets the specified user’s console password information.

        The returned object contains the user’s OCID, but not the password itself. The actual password is returned only when created or reset.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetUserUIPasswordInformationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUserUIPasswordInformation API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets details on a specified work request.

        The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the compartment service.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • importStandardTags

        ImportStandardTagsResponse importStandardTags​(ImportStandardTagsRequest request)
        OCI will release Tag Namespaces that our customers can import.

        These Tag Namespaces will provide Tags for our customers and Partners to provide consistency and enable data reporting.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ImportStandardTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportStandardTags API.

      • listAllowedDomainLicenseTypes

        ListAllowedDomainLicenseTypesResponse listAllowedDomainLicenseTypes​(ListAllowedDomainLicenseTypesRequest request)
        (For tenancies that support identity domains) Lists the license types for identity domains supported by Oracle Cloud Infrastructure.

        (License types are also referred to as domain types.)

        If `currentLicenseTypeName` is provided, then the request returns license types that the identity domain with the specified license type name can change to. Otherwise, the request returns all valid license types currently supported.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListAllowedDomainLicenseTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAllowedDomainLicenseTypes API.

      • listApiKeys

        ListApiKeysResponse listApiKeys​(ListApiKeysRequest request)
        Lists the API signing keys for the specified user.

        A user can have a maximum of three keys.

        Every user has permission to use this API call for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListApiKeysExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListApiKeys API.

      • listAuthTokens

        ListAuthTokensResponse listAuthTokens​(ListAuthTokensRequest request)
        Lists the auth tokens for the specified user.

        The returned object contains the token’s OCID, but not the token itself. The actual token is returned only upon creation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListAuthTokensExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAuthTokens API.

      • listAvailabilityDomains

        ListAvailabilityDomainsResponse listAvailabilityDomains​(ListAvailabilityDomainsRequest request)
        Lists the availability domains in your tenancy.

        Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID. Note that the order of the results returned can change if availability domains are added or removed; therefore, do not create a dependency on the list order.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListAvailabilityDomainsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAvailabilityDomains API.

      • listBulkActionResourceTypes

        ListBulkActionResourceTypesResponse listBulkActionResourceTypes​(ListBulkActionResourceTypesRequest request)
        Lists the resource-types supported by compartment bulk actions.

        Use this API to help you provide the correct resource-type information to the bulkDeleteResources and bulkMoveResources operations. The returned list of resource-types provides the appropriate resource-type names to use with the bulk action operations along with the type of identifying information you’ll need to provide for each resource-type. Most resource-types just require an OCID to identify a specific resource, but some resource-types, such as buckets, require you to provide other identifying information.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListBulkActionResourceTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBulkActionResourceTypes API.

      • listBulkEditTagsResourceTypes

        ListBulkEditTagsResourceTypesResponse listBulkEditTagsResourceTypes​(ListBulkEditTagsResourceTypesRequest request)
        Lists the resource types that support bulk tag editing.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListBulkEditTagsResourceTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBulkEditTagsResourceTypes API.

      • listCompartments

        ListCompartmentsResponse listCompartments​(ListCompartmentsRequest request)
        Lists the compartments in a specified compartment.

        The members of the list returned depends on the values set for several parameters.

        With the exception of the tenancy (root compartment), the ListCompartments operation returns only the first-level child compartments in the parent compartment specified in `compartmentId`. The list does not include any subcompartments of the child compartments (grandchildren).

        The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (the resource can be in a subcompartment).

        The parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the tenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY.

        See [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListCompartmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCompartments API.

      • listCostTrackingTags

        ListCostTrackingTagsResponse listCostTrackingTags​(ListCostTrackingTagsRequest request)
        Lists all the tags enabled for cost-tracking in the specified tenancy.

        For information about cost-tracking tags, see Using Cost-tracking Tags.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListCostTrackingTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCostTrackingTags API.

      • listCustomerSecretKeys

        ListCustomerSecretKeysResponse listCustomerSecretKeys​(ListCustomerSecretKeysRequest request)
        Lists the secret keys for the specified user.

        The returned object contains the secret key’s OCID, but not the secret key itself. The actual secret key is returned only upon creation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListCustomerSecretKeysExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCustomerSecretKeys API.

      • listDbCredentials

        ListDbCredentialsResponse listDbCredentials​(ListDbCredentialsRequest request)
        Lists the DB credentials for the specified user.

        The returned object contains the credential’s OCID

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListDbCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDbCredentials API.

      • listDomains

        ListDomainsResponse listDomains​(ListDomainsRequest request)
        (For tenancies that support identity domains) Lists all identity domains within a tenancy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListDomainsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDomains API.

      • listDynamicGroups

        ListDynamicGroupsResponse listDynamicGroups​(ListDynamicGroupsRequest request)
        Lists the dynamic groups in your tenancy.

        You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListDynamicGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDynamicGroups API.

      • listFaultDomains

        ListFaultDomainsResponse listFaultDomains​(ListFaultDomainsRequest request)
        Lists the Fault Domains in your tenancy.

        Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListFaultDomainsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFaultDomains API.

      • listGroups

        ListGroupsResponse listGroups​(ListGroupsRequest request)
        Lists the groups in your tenancy.

        You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGroups API.

      • listIamWorkRequestErrors

        ListIamWorkRequestErrorsResponse listIamWorkRequestErrors​(ListIamWorkRequestErrorsRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListIamWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIamWorkRequestErrors API.

      • listIamWorkRequestLogs

        ListIamWorkRequestLogsResponse listIamWorkRequestLogs​(ListIamWorkRequestLogsRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListIamWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIamWorkRequestLogs API.

      • listIamWorkRequests

        ListIamWorkRequestsResponse listIamWorkRequests​(ListIamWorkRequestsRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListIamWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIamWorkRequests API.

      • listIdentityProviderGroups

        ListIdentityProviderGroupsResponse listIdentityProviderGroups​(ListIdentityProviderGroupsRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Lists the identity provider groups.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListIdentityProviderGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIdentityProviderGroups API.

      • listIdentityProviders

        ListIdentityProvidersResponse listIdentityProviders​(ListIdentityProvidersRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListIdentityProvidersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIdentityProviders API.

      • listIdpGroupMappings

        ListIdpGroupMappingsResponse listIdpGroupMappings​(ListIdpGroupMappingsRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Lists the group mappings for the specified identity provider.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListIdpGroupMappingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIdpGroupMappings API.

      • listMfaTotpDevices

        ListMfaTotpDevicesResponse listMfaTotpDevices​(ListMfaTotpDevicesRequest request)
        Lists the MFA TOTP devices for the specified user.

        The returned object contains the device’s OCID, but not the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListMfaTotpDevicesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMfaTotpDevices API.

      • listNetworkSources

        ListNetworkSourcesResponse listNetworkSources​(ListNetworkSourcesRequest request)
        Lists the network sources in your tenancy.

        You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListNetworkSourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListNetworkSources API.

      • listOAuthClientCredentials

        ListOAuthClientCredentialsResponse listOAuthClientCredentials​(ListOAuthClientCredentialsRequest request)
        List of Oauth tokens for the user
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListOAuthClientCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOAuthClientCredentials API.

      • listPolicies

        ListPoliciesResponse listPolicies​(ListPoliciesRequest request)
        Lists the policies in the specified compartment (either the tenancy or another of your compartments).

        See Where to Get the Tenancy’s OCID and User’s OCID.

        To determine which policies apply to a particular group or compartment, you must view the individual statements inside all your policies. There isn't a way to automatically obtain that information via the API.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPolicies API.

      • listRegionSubscriptions

        ListRegionSubscriptionsResponse listRegionSubscriptions​(ListRegionSubscriptionsRequest request)
        Lists the region subscriptions for the specified tenancy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListRegionSubscriptionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRegionSubscriptions API.

      • listRegions

        ListRegionsResponse listRegions​(ListRegionsRequest request)
        Lists all the regions offered by Oracle Cloud Infrastructure.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListRegionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRegions API.

      • listSmtpCredentials

        ListSmtpCredentialsResponse listSmtpCredentials​(ListSmtpCredentialsRequest request)
        Lists the SMTP credentials for the specified user.

        The returned object contains the credential’s OCID, the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListSmtpCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSmtpCredentials API.

      • listStandardTagNamespaces

        ListStandardTagNamespacesResponse listStandardTagNamespaces​(ListStandardTagNamespacesRequest request)
        Lists available standard tag namespaces that users can create.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListStandardTagNamespacesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStandardTagNamespaces API.

      • listSwiftPasswords

        ListSwiftPasswordsResponse listSwiftPasswords​(ListSwiftPasswordsRequest request)
        **Deprecated.

        Use listAuthTokens instead.**

        Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not the password itself. The actual password is returned only upon creation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListSwiftPasswordsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSwiftPasswords API.

      • listTagDefaults

        ListTagDefaultsResponse listTagDefaults​(ListTagDefaultsRequest request)
        Lists the tag defaults for tag definitions in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListTagDefaultsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTagDefaults API.

      • listTagNamespaces

        ListTagNamespacesResponse listTagNamespaces​(ListTagNamespacesRequest request)
        Lists the tag namespaces in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListTagNamespacesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTagNamespaces API.

      • listTaggingWorkRequestErrors

        ListTaggingWorkRequestErrorsResponse listTaggingWorkRequestErrors​(ListTaggingWorkRequestErrorsRequest request)
        Gets the errors for a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListTaggingWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaggingWorkRequestErrors API.

      • listTaggingWorkRequestLogs

        ListTaggingWorkRequestLogsResponse listTaggingWorkRequestLogs​(ListTaggingWorkRequestLogsRequest request)
        Gets the logs for a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListTaggingWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaggingWorkRequestLogs API.

      • listTaggingWorkRequests

        ListTaggingWorkRequestsResponse listTaggingWorkRequests​(ListTaggingWorkRequestsRequest request)
        Lists the tagging work requests in compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListTaggingWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaggingWorkRequests API.

      • listTags

        ListTagsResponse listTags​(ListTagsRequest request)
        Lists the tag definitions in the specified tag namespace.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListTagsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTags API.

      • listUserGroupMemberships

        ListUserGroupMembershipsResponse listUserGroupMemberships​(ListUserGroupMembershipsRequest request)
        Lists the UserGroupMembership objects in your tenancy.

        You must specify your tenancy’s OCID as the value for the compartment ID (see Where to Get the Tenancy’s OCID and User’s OCID). You must also then filter the list in one of these ways:

        - You can limit the results to just the memberships for a given user by specifying a `userId`. - Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`. - You can set both the `userId` and `groupId` to determine if the specified user is in the specified group. If the answer is no, the response is an empty list. - Although`userId` and `groupId` are not individually required, you must set one of them.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListUserGroupMembershipsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUserGroupMemberships API.

      • listUsers

        ListUsersResponse listUsers​(ListUsersRequest request)
        Lists the users in your tenancy.

        You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListUsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUsers API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • moveCompartment

        MoveCompartmentResponse moveCompartment​(MoveCompartmentRequest request)
        Move the compartment to a different parent compartment in the same tenancy.

        When you move a compartment, all its contents (subcompartments and resources) are moved with it. Note that the CompartmentId that you specify in the path is the compartment that you want to move.

        *IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of the new parent take effect and the policies of the previous parent no longer apply. Ensure that you are aware of the implications for the compartment contents before you move it. For more information, see [Moving a Compartment](https://docs.oracle.com/iaas/Content/Identity/compartments/managingcompartments.htm#MoveCompartment).

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/MoveCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use MoveCompartment API.

      • recoverCompartment

        RecoverCompartmentResponse recoverCompartment​(RecoverCompartmentRequest request)
        Recover the compartment from DELETED state to ACTIVE state.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/RecoverCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RecoverCompartment API.

      • removeTagDefaultLock

        RemoveTagDefaultLockResponse removeTagDefaultLock​(RemoveTagDefaultLockRequest request)
        Remove a resource lock from a tag default.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/RemoveTagDefaultLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveTagDefaultLock API.

      • removeTagNamespaceLock

        RemoveTagNamespaceLockResponse removeTagNamespaceLock​(RemoveTagNamespaceLockRequest request)
        Remove a resource lock from a tag namespace.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/RemoveTagNamespaceLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveTagNamespaceLock API.

      • removeUserFromGroup

        RemoveUserFromGroupResponse removeUserFromGroup​(RemoveUserFromGroupRequest request)
        Removes a user from a group by deleting the corresponding UserGroupMembership.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/RemoveUserFromGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveUserFromGroup API.

      • resetIdpScimClient

        ResetIdpScimClientResponse resetIdpScimClient​(ResetIdpScimClientRequest request)
        Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/ResetIdpScimClientExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ResetIdpScimClient API.

      • updateAuthToken

        UpdateAuthTokenResponse updateAuthToken​(UpdateAuthTokenRequest request)
        Updates the specified auth token’s description.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateAuthTokenExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAuthToken API.

      • updateAuthenticationPolicy

        UpdateAuthenticationPolicyResponse updateAuthenticationPolicy​(UpdateAuthenticationPolicyRequest request)
        Updates authentication policy for the specified tenancy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateAuthenticationPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateAuthenticationPolicy API.

      • updateCompartment

        UpdateCompartmentResponse updateCompartment​(UpdateCompartmentRequest request)
        Updates the specified compartment’s description or name.

        You can’t update the root compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCompartment API.

      • updateCustomerSecretKey

        UpdateCustomerSecretKeyResponse updateCustomerSecretKey​(UpdateCustomerSecretKeyRequest request)
        Updates the specified secret key’s description.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateCustomerSecretKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCustomerSecretKey API.

      • updateDomain

        UpdateDomainResponse updateDomain​(UpdateDomainRequest request)
        (For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe.

        To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDomain API.

      • updateDynamicGroup

        UpdateDynamicGroupResponse updateDynamicGroup​(UpdateDynamicGroupRequest request)
        Updates the specified dynamic group.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateDynamicGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDynamicGroup API.

      • updateGroup

        UpdateGroupResponse updateGroup​(UpdateGroupRequest request)
        Updates the specified group.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateGroup API.

      • updateIdentityProvider

        UpdateIdentityProviderResponse updateIdentityProvider​(UpdateIdentityProviderRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Updates the specified identity provider.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateIdentityProviderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateIdentityProvider API.

      • updateIdpGroupMapping

        UpdateIdpGroupMappingResponse updateIdpGroupMapping​(UpdateIdpGroupMappingRequest request)
        Deprecated. For more information, see Deprecated IAM Service APIs.

        Updates the specified group mapping.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateIdpGroupMappingExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateIdpGroupMapping API.

      • updateNetworkSource

        UpdateNetworkSourceResponse updateNetworkSource​(UpdateNetworkSourceRequest request)
        Updates the specified network source.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateNetworkSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateNetworkSource API.

      • updateOAuthClientCredential

        UpdateOAuthClientCredentialResponse updateOAuthClientCredential​(UpdateOAuthClientCredentialRequest request)
        Updates Oauth token for the user
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateOAuthClientCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOAuthClientCredential API.

      • updatePolicy

        UpdatePolicyResponse updatePolicy​(UpdatePolicyRequest request)
        Updates the specified policy.

        You can update the description or the policy statements themselves.

        Policy changes take effect typically within 10 seconds.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdatePolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePolicy API.

      • updateSmtpCredential

        UpdateSmtpCredentialResponse updateSmtpCredential​(UpdateSmtpCredentialRequest request)
        Updates the specified SMTP credential’s description.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateSmtpCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSmtpCredential API.

      • updateSwiftPassword

        UpdateSwiftPasswordResponse updateSwiftPassword​(UpdateSwiftPasswordRequest request)
        **Deprecated.

        Use updateAuthToken instead.**

        Updates the specified Swift password's description.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateSwiftPasswordExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSwiftPassword API.

      • updateTag

        UpdateTagResponse updateTag​(UpdateTagRequest request)
        Updates the specified tag definition.

        Setting `validator` determines the value type. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. On update, any values in a list that were previously set do not change, but new values must pass validation. Values already applied to a resource do not change.

        You cannot remove list values that appear in a TagDefault. To remove a list value that appears in a TagDefault, first update the TagDefault to use a different value.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateTagExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTag API.

      • updateTagDefault

        UpdateTagDefaultResponse updateTagDefault​(UpdateTagDefaultRequest request)
        Updates the specified tag default.

        If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.

        If the `isRequired` flag is set to \"true\", the value is set during resource creation. * If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateTagDefaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTagDefault API.

      • updateTagNamespace

        UpdateTagNamespaceResponse updateTagNamespace​(UpdateTagNamespaceRequest request)
        Updates the the specified tag namespace.

        You can’t update the namespace name.

        Updating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a namespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions. To reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace, using updateTag. For more information about retiring tag namespaces, see [Retiring Key Definitions and Namespace Definitions](https://docs.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).

        You can't add a namespace with the same name as a retired namespace in the same tenancy.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateTagNamespaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTagNamespace API.

      • updateUser

        UpdateUserResponse updateUser​(UpdateUserRequest request)
        Updates the description of the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateUser API.

      • updateUserCapabilities

        UpdateUserCapabilitiesResponse updateUserCapabilities​(UpdateUserCapabilitiesRequest request)
        Updates the capabilities of the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateUserCapabilitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateUserCapabilities API.

      • updateUserState

        UpdateUserStateResponse updateUserState​(UpdateUserStateRequest request)
        Updates the state of the specified user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UpdateUserStateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateUserState API.

      • uploadApiKey

        UploadApiKeyResponse uploadApiKey​(UploadApiKeyRequest request)
        Uploads an API signing key for the specified user.

        Every user has permission to use this operation to upload a key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to upload a key for any user, including themselves.

        *Important:** Even though you have permission to upload an API key, you might not yet have permission to do much else. If you try calling an operation unrelated to your own credential management (e.g., `ListUsers`, `LaunchInstance`) and receive an \"unauthorized\" error, check with an administrator to confirm which IAM Service group(s) you're in and what access you have. Also confirm you're working in the correct compartment.

        After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/identity/UploadApiKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UploadApiKey API.

      • getWaiters

        IdentityWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.
      • getPaginators

        IdentityPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.