Class IdentityAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.identity.IdentityAsyncClient
-
- All Implemented Interfaces:
IdentityAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class IdentityAsyncClient extends BaseAsyncClient implements IdentityAsync
Async client implementation for Identity service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IdentityAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Identity.
-
Constructor Summary
Constructors Constructor Description IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.identity.IdentityAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
IdentityAsyncClient
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static IdentityAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:IdentityAsync
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.- Specified by:
setRegion
in interfaceIdentityAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:IdentityAsync
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceIdentityAsync
- Parameters:
regionId
- The public region ID.
-
activateDomain
public Future<ActivateDomainResponse> activateDomain(ActivateDomainRequest request, AsyncHandler<ActivateDomainRequest,ActivateDomainResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
activateDomain
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
activateMfaTotpDevice
public Future<ActivateMfaTotpDeviceResponse> activateMfaTotpDevice(ActivateMfaTotpDeviceRequest request, AsyncHandler<ActivateMfaTotpDeviceRequest,ActivateMfaTotpDeviceResponse> handler)
Description copied from interface:IdentityAsync
Activates the specified MFA TOTP device for the user.Activation requires manual interaction with the Console.
- Specified by:
activateMfaTotpDevice
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
addTagDefaultLock
public Future<AddTagDefaultLockResponse> addTagDefaultLock(AddTagDefaultLockRequest request, AsyncHandler<AddTagDefaultLockRequest,AddTagDefaultLockResponse> handler)
Description copied from interface:IdentityAsync
Add a resource lock to a tag default.- Specified by:
addTagDefaultLock
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
addTagNamespaceLock
public Future<AddTagNamespaceLockResponse> addTagNamespaceLock(AddTagNamespaceLockRequest request, AsyncHandler<AddTagNamespaceLockRequest,AddTagNamespaceLockResponse> handler)
Description copied from interface:IdentityAsync
Add a resource lock to a tag namespace.- Specified by:
addTagNamespaceLock
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
addUserToGroup
public Future<AddUserToGroupResponse> addUserToGroup(AddUserToGroupRequest request, AsyncHandler<AddUserToGroupRequest,AddUserToGroupResponse> handler)
Description copied from interface:IdentityAsync
Adds the specified user to the specified group and returns aUserGroupMembership
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.
- Specified by:
addUserToGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
assembleEffectiveTagSet
public Future<AssembleEffectiveTagSetResponse> assembleEffectiveTagSet(AssembleEffectiveTagSetRequest request, AsyncHandler<AssembleEffectiveTagSetRequest,AssembleEffectiveTagSetResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
assembleEffectiveTagSet
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
bulkDeleteResources
public Future<BulkDeleteResourcesResponse> bulkDeleteResources(BulkDeleteResourcesRequest request, AsyncHandler<BulkDeleteResourcesRequest,BulkDeleteResourcesResponse> handler)
Description copied from interface:IdentityAsync
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 thegetWorkRequest
API to monitor the status of the bulk action.- Specified by:
bulkDeleteResources
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
bulkDeleteTags
public Future<BulkDeleteTagsResponse> bulkDeleteTags(BulkDeleteTagsRequest request, AsyncHandler<BulkDeleteTagsRequest,BulkDeleteTagsResponse> handler)
Description copied from interface:IdentityAsync
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 thecascadeDeleteTagNamespace
operation until this process completes.In order to delete tags, you must first retire the tags. Use
updateTag
to retire a tag.- Specified by:
bulkDeleteTags
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
bulkEditTags
public Future<BulkEditTagsResponse> bulkEditTags(BulkEditTagsRequest request, AsyncHandler<BulkEditTagsRequest,BulkEditTagsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
bulkEditTags
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
bulkMoveResources
public Future<BulkMoveResourcesResponse> bulkMoveResources(BulkMoveResourcesRequest request, AsyncHandler<BulkMoveResourcesRequest,BulkMoveResourcesResponse> handler)
Description copied from interface:IdentityAsync
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 thegetWorkRequest
API to monitor the status of the bulk action.- Specified by:
bulkMoveResources
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
cascadeDeleteTagNamespace
public Future<CascadeDeleteTagNamespaceResponse> cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest request, AsyncHandler<CascadeDeleteTagNamespaceRequest,CascadeDeleteTagNamespaceResponse> handler)
Description copied from interface:IdentityAsync
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 thebulkDeleteTags
operation until this process completes.To delete a tag namespace, you must first retire it. Use
updateTagNamespace
to retire a tag namespace.- Specified by:
cascadeDeleteTagNamespace
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeDomainCompartment
public Future<ChangeDomainCompartmentResponse> changeDomainCompartment(ChangeDomainCompartmentRequest request, AsyncHandler<ChangeDomainCompartmentRequest,ChangeDomainCompartmentResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
changeDomainCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeDomainLicenseType
public Future<ChangeDomainLicenseTypeResponse> changeDomainLicenseType(ChangeDomainLicenseTypeRequest request, AsyncHandler<ChangeDomainLicenseTypeRequest,ChangeDomainLicenseTypeResponse> handler)
Description copied from interface:IdentityAsync
(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 requestedlicenseType
must be allowed. To retrieve the allowedlicenseType
for the identity domain, uselistAllowedDomainLicenseTypes
.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.
- Specified by:
changeDomainLicenseType
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeTagNamespaceCompartment
public Future<ChangeTagNamespaceCompartmentResponse> changeTagNamespaceCompartment(ChangeTagNamespaceCompartmentRequest request, AsyncHandler<ChangeTagNamespaceCompartmentRequest,ChangeTagNamespaceCompartmentResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
changeTagNamespaceCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createAuthToken
public Future<CreateAuthTokenResponse> createAuthToken(CreateAuthTokenRequest request, AsyncHandler<CreateAuthTokenRequest,CreateAuthTokenResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createAuthToken
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createCompartment
public Future<CreateCompartmentResponse> createCompartment(CreateCompartmentRequest request, AsyncHandler<CreateCompartmentRequest,CreateCompartmentResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createCustomerSecretKey
public Future<CreateCustomerSecretKeyResponse> createCustomerSecretKey(CreateCustomerSecretKeyRequest request, AsyncHandler<CreateCustomerSecretKeyRequest,CreateCustomerSecretKeyResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createCustomerSecretKey
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createDbCredential
public Future<CreateDbCredentialResponse> createDbCredential(CreateDbCredentialRequest request, AsyncHandler<CreateDbCredentialRequest,CreateDbCredentialResponse> handler)
Description copied from interface:IdentityAsync
Creates a new DB credential for the specified user.- Specified by:
createDbCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createDomain
public Future<CreateDomainResponse> createDomain(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResponse> handler)
Description copied from interface:IdentityAsync
(For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home inhomeRegion
.After you send your request, the temporary
lifecycleState
of this identity domain is set to CREATING andlifecycleDetails
to UPDATING. When creation of the identity domain completes, this identity domain’slifecycleState
is set to ACTIVE andlifecycleDetails
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.
- Specified by:
createDomain
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createDynamicGroup
public Future<CreateDynamicGroupResponse> createDynamicGroup(CreateDynamicGroupRequest request, AsyncHandler<CreateDynamicGroupRequest,CreateDynamicGroupResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createDynamicGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createGroup
public Future<CreateGroupResponse> createGroup(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResponse> handler)
Description copied from interface:IdentityAsync
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
andcreatePolicy
.- Specified by:
createGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createIdentityProvider
public Future<CreateIdentityProviderResponse> createIdentityProvider(CreateIdentityProviderRequest request, AsyncHandler<CreateIdentityProviderRequest,CreateIdentityProviderResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createIdentityProvider
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createIdpGroupMapping
public Future<CreateIdpGroupMappingResponse> createIdpGroupMapping(CreateIdpGroupMappingRequest request, AsyncHandler<CreateIdpGroupMappingRequest,CreateIdpGroupMappingResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Creates a single mapping between an IdP group and an IAM Service
Group
.- Specified by:
createIdpGroupMapping
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createMfaTotpDevice
public Future<CreateMfaTotpDeviceResponse> createMfaTotpDevice(CreateMfaTotpDeviceRequest request, AsyncHandler<CreateMfaTotpDeviceRequest,CreateMfaTotpDeviceResponse> handler)
Description copied from interface:IdentityAsync
Creates a new MFA TOTP device for the user.A user can have one MFA TOTP device.
- Specified by:
createMfaTotpDevice
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createNetworkSource
public Future<CreateNetworkSourceResponse> createNetworkSource(CreateNetworkSourceRequest request, AsyncHandler<CreateNetworkSourceRequest,CreateNetworkSourceResponse> handler)
Description copied from interface:IdentityAsync
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).
- Specified by:
createNetworkSource
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createOAuthClientCredential
public Future<CreateOAuthClientCredentialResponse> createOAuthClientCredential(CreateOAuthClientCredentialRequest request, AsyncHandler<CreateOAuthClientCredentialRequest,CreateOAuthClientCredentialResponse> handler)
Description copied from interface:IdentityAsync
Creates Oauth token for the user- Specified by:
createOAuthClientCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createOrResetUIPassword
public Future<CreateOrResetUIPasswordResponse> createOrResetUIPassword(CreateOrResetUIPasswordRequest request, AsyncHandler<CreateOrResetUIPasswordRequest,CreateOrResetUIPasswordResponse> handler)
Description copied from interface:IdentityAsync
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
).- Specified by:
createOrResetUIPassword
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createPolicy
public Future<CreatePolicyResponse> createPolicy(CreatePolicyRequest request, AsyncHandler<CreatePolicyRequest,CreatePolicyResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createPolicy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createRegionSubscription
public Future<CreateRegionSubscriptionResponse> createRegionSubscription(CreateRegionSubscriptionRequest request, AsyncHandler<CreateRegionSubscriptionRequest,CreateRegionSubscriptionResponse> handler)
Description copied from interface:IdentityAsync
Creates a subscription to a region for a tenancy.- Specified by:
createRegionSubscription
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createSmtpCredential
public Future<CreateSmtpCredentialResponse> createSmtpCredential(CreateSmtpCredentialRequest request, AsyncHandler<CreateSmtpCredentialRequest,CreateSmtpCredentialResponse> handler)
Description copied from interface:IdentityAsync
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
.- Specified by:
createSmtpCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createSwiftPassword
public Future<CreateSwiftPasswordResponse> createSwiftPassword(CreateSwiftPasswordRequest request, AsyncHandler<CreateSwiftPasswordRequest,CreateSwiftPasswordResponse> handler)
Description copied from interface:IdentityAsync
**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.
- Specified by:
createSwiftPassword
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createTag
public Future<CreateTagResponse> createTag(CreateTagRequest request, AsyncHandler<CreateTagRequest,CreateTagResponse> handler)
Description copied from interface:IdentityAsync
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
.- Specified by:
createTag
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createTagDefault
public Future<CreateTagDefaultResponse> createTagDefault(CreateTagDefaultRequest request, AsyncHandler<CreateTagDefaultRequest,CreateTagDefaultResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
createTagDefault
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createTagNamespace
public Future<CreateTagNamespaceResponse> createTagNamespace(CreateTagNamespaceRequest request, AsyncHandler<CreateTagNamespaceRequest,CreateTagNamespaceResponse> handler)
Description copied from interface:IdentityAsync
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
.- Specified by:
createTagNamespace
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createUser
public Future<CreateUserResponse> createUser(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResponse> handler)
Description copied from interface:IdentityAsync
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 (seecreateOrResetUIPassword
). 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 alsouploadApiKey
).*Important:** Make sure to inform the new user which compartment(s) they have access to.
- Specified by:
createUser
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deactivateDomain
public Future<DeactivateDomainResponse> deactivateDomain(DeactivateDomainRequest request, AsyncHandler<DeactivateDomainRequest,DeactivateDomainResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
deactivateDomain
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteApiKey
public Future<DeleteApiKeyResponse> deleteApiKey(DeleteApiKeyRequest request, AsyncHandler<DeleteApiKeyRequest,DeleteApiKeyResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
deleteApiKey
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteAuthToken
public Future<DeleteAuthTokenResponse> deleteAuthToken(DeleteAuthTokenRequest request, AsyncHandler<DeleteAuthTokenRequest,DeleteAuthTokenResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified auth token for the specified user.- Specified by:
deleteAuthToken
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteCompartment
public Future<DeleteCompartmentResponse> deleteCompartment(DeleteCompartmentRequest request, AsyncHandler<DeleteCompartmentRequest,DeleteCompartmentResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified compartment.The compartment must be empty.
- Specified by:
deleteCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteCustomerSecretKey
public Future<DeleteCustomerSecretKeyResponse> deleteCustomerSecretKey(DeleteCustomerSecretKeyRequest request, AsyncHandler<DeleteCustomerSecretKeyRequest,DeleteCustomerSecretKeyResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified secret key for the specified user.- Specified by:
deleteCustomerSecretKey
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteDbCredential
public Future<DeleteDbCredentialResponse> deleteDbCredential(DeleteDbCredentialRequest request, AsyncHandler<DeleteDbCredentialRequest,DeleteDbCredentialResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified DB credential for the specified user.- Specified by:
deleteDbCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteDomain
public Future<DeleteDomainResponse> deleteDomain(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
deleteDomain
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteDynamicGroup
public Future<DeleteDynamicGroupResponse> deleteDynamicGroup(DeleteDynamicGroupRequest request, AsyncHandler<DeleteDynamicGroupRequest,DeleteDynamicGroupResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified dynamic group.- Specified by:
deleteDynamicGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteGroup
public Future<DeleteGroupResponse> deleteGroup(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified group.The group must be empty.
- Specified by:
deleteGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteIdentityProvider
public Future<DeleteIdentityProviderResponse> deleteIdentityProvider(DeleteIdentityProviderRequest request, AsyncHandler<DeleteIdentityProviderRequest,DeleteIdentityProviderResponse> handler)
Description copied from interface:IdentityAsync
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
).- Specified by:
deleteIdentityProvider
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteIdpGroupMapping
public Future<DeleteIdpGroupMappingResponse> deleteIdpGroupMapping(DeleteIdpGroupMappingRequest request, AsyncHandler<DeleteIdpGroupMappingRequest,DeleteIdpGroupMappingResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Deletes the specified group mapping.
- Specified by:
deleteIdpGroupMapping
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteMfaTotpDevice
public Future<DeleteMfaTotpDeviceResponse> deleteMfaTotpDevice(DeleteMfaTotpDeviceRequest request, AsyncHandler<DeleteMfaTotpDeviceRequest,DeleteMfaTotpDeviceResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified MFA TOTP device for the specified user.- Specified by:
deleteMfaTotpDevice
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteNetworkSource
public Future<DeleteNetworkSourceResponse> deleteNetworkSource(DeleteNetworkSourceRequest request, AsyncHandler<DeleteNetworkSourceRequest,DeleteNetworkSourceResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified network source.- Specified by:
deleteNetworkSource
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteOAuthClientCredential
public Future<DeleteOAuthClientCredentialResponse> deleteOAuthClientCredential(DeleteOAuthClientCredentialRequest request, AsyncHandler<DeleteOAuthClientCredentialRequest,DeleteOAuthClientCredentialResponse> handler)
Description copied from interface:IdentityAsync
Delete Oauth token for the user- Specified by:
deleteOAuthClientCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deletePolicy
public Future<DeletePolicyResponse> deletePolicy(DeletePolicyRequest request, AsyncHandler<DeletePolicyRequest,DeletePolicyResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified policy.The deletion takes effect typically within 10 seconds.
- Specified by:
deletePolicy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteSmtpCredential
public Future<DeleteSmtpCredentialResponse> deleteSmtpCredential(DeleteSmtpCredentialRequest request, AsyncHandler<DeleteSmtpCredentialRequest,DeleteSmtpCredentialResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified SMTP credential for the specified user.- Specified by:
deleteSmtpCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteSwiftPassword
public Future<DeleteSwiftPasswordResponse> deleteSwiftPassword(DeleteSwiftPasswordRequest request, AsyncHandler<DeleteSwiftPasswordRequest,DeleteSwiftPasswordResponse> handler)
Description copied from interface:IdentityAsync
**Deprecated.Use
deleteAuthToken
instead.**Deletes the specified Swift password for the specified user.
- Specified by:
deleteSwiftPassword
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteTag
public Future<DeleteTagResponse> deleteTag(DeleteTagRequest request, AsyncHandler<DeleteTagRequest,DeleteTagResponse> handler)
Description copied from interface:IdentityAsync
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 thecascadeDeleteTagNamespace
operation until this process completes.To delete a tag, you must first retire it. Use
updateTag
to retire a tag.- Specified by:
deleteTag
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteTagDefault
public Future<DeleteTagDefaultResponse> deleteTagDefault(DeleteTagDefaultRequest request, AsyncHandler<DeleteTagDefaultRequest,DeleteTagDefaultResponse> handler)
Description copied from interface:IdentityAsync
Deletes the the specified tag default.- Specified by:
deleteTagDefault
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteTagNamespace
public Future<DeleteTagNamespaceResponse> deleteTagNamespace(DeleteTagNamespaceRequest request, AsyncHandler<DeleteTagNamespaceRequest,DeleteTagNamespaceResponse> handler)
Description copied from interface:IdentityAsync
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.- Specified by:
deleteTagNamespace
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteUser
public Future<DeleteUserResponse> deleteUser(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResponse> handler)
Description copied from interface:IdentityAsync
Deletes the specified user.The user must not be in any groups.
- Specified by:
deleteUser
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
enableReplicationToRegion
public Future<EnableReplicationToRegionResponse> enableReplicationToRegion(EnableReplicationToRegionRequest request, AsyncHandler<EnableReplicationToRegionRequest,EnableReplicationToRegionResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
enableReplicationToRegion
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
generateTotpSeed
public Future<GenerateTotpSeedResponse> generateTotpSeed(GenerateTotpSeedRequest request, AsyncHandler<GenerateTotpSeedRequest,GenerateTotpSeedResponse> handler)
Description copied from interface:IdentityAsync
Generate seed for the MFA TOTP device.- Specified by:
generateTotpSeed
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getAuthenticationPolicy
public Future<GetAuthenticationPolicyResponse> getAuthenticationPolicy(GetAuthenticationPolicyRequest request, AsyncHandler<GetAuthenticationPolicyRequest,GetAuthenticationPolicyResponse> handler)
Description copied from interface:IdentityAsync
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).
- Specified by:
getAuthenticationPolicy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getCompartment
public Future<GetCompartmentResponse> getCompartment(GetCompartmentRequest request, AsyncHandler<GetCompartmentRequest,GetCompartmentResponse> handler)
Description copied from interface:IdentityAsync
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 thelistVolumes
operation in Cloud Block Storage.- Specified by:
getCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDomain
public Future<GetDomainResponse> getDomain(GetDomainRequest request, AsyncHandler<GetDomainRequest,GetDomainResponse> handler)
Description copied from interface:IdentityAsync
(For tenancies that support identity domains) Gets the specified identity domain’s information.- Specified by:
getDomain
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDynamicGroup
public Future<GetDynamicGroupResponse> getDynamicGroup(GetDynamicGroupRequest request, AsyncHandler<GetDynamicGroupRequest,GetDynamicGroupResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified dynamic group’s information.- Specified by:
getDynamicGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getGroup
public Future<GetGroupResponse> getGroup(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResponse> handler)
Description copied from interface:IdentityAsync
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.- Specified by:
getGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getIamWorkRequest
public Future<GetIamWorkRequestResponse> getIamWorkRequest(GetIamWorkRequestRequest request, AsyncHandler<GetIamWorkRequestRequest,GetIamWorkRequestResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
getIamWorkRequest
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getIdentityProvider
public Future<GetIdentityProviderResponse> getIdentityProvider(GetIdentityProviderRequest request, AsyncHandler<GetIdentityProviderRequest,GetIdentityProviderResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Gets the specified identity provider's information.
- Specified by:
getIdentityProvider
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getIdpGroupMapping
public Future<GetIdpGroupMappingResponse> getIdpGroupMapping(GetIdpGroupMappingRequest request, AsyncHandler<GetIdpGroupMappingRequest,GetIdpGroupMappingResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Gets the specified group mapping.
- Specified by:
getIdpGroupMapping
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getMfaTotpDevice
public Future<GetMfaTotpDeviceResponse> getMfaTotpDevice(GetMfaTotpDeviceRequest request, AsyncHandler<GetMfaTotpDeviceRequest,GetMfaTotpDeviceResponse> handler)
Description copied from interface:IdentityAsync
Get the specified MFA TOTP device for the specified user.- Specified by:
getMfaTotpDevice
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getNetworkSource
public Future<GetNetworkSourceResponse> getNetworkSource(GetNetworkSourceRequest request, AsyncHandler<GetNetworkSourceRequest,GetNetworkSourceResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified network source’s information.- Specified by:
getNetworkSource
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getPolicy
public Future<GetPolicyResponse> getPolicy(GetPolicyRequest request, AsyncHandler<GetPolicyRequest,GetPolicyResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified policy’s information.- Specified by:
getPolicy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getStandardTagTemplate
public Future<GetStandardTagTemplateResponse> getStandardTagTemplate(GetStandardTagTemplateRequest request, AsyncHandler<GetStandardTagTemplateRequest,GetStandardTagTemplateResponse> handler)
Description copied from interface:IdentityAsync
Retrieve the standard tag namespace template given the standard tag namespace name.- Specified by:
getStandardTagTemplate
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTag
public Future<GetTagResponse> getTag(GetTagRequest request, AsyncHandler<GetTagRequest,GetTagResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified tag’s information.- Specified by:
getTag
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTagDefault
public Future<GetTagDefaultResponse> getTagDefault(GetTagDefaultRequest request, AsyncHandler<GetTagDefaultRequest,GetTagDefaultResponse> handler)
Description copied from interface:IdentityAsync
Retrieves the specified tag default.- Specified by:
getTagDefault
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTagNamespace
public Future<GetTagNamespaceResponse> getTagNamespace(GetTagNamespaceRequest request, AsyncHandler<GetTagNamespaceRequest,GetTagNamespaceResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified tag namespace’s information.- Specified by:
getTagNamespace
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTaggingWorkRequest
public Future<GetTaggingWorkRequestResponse> getTaggingWorkRequest(GetTaggingWorkRequestRequest request, AsyncHandler<GetTaggingWorkRequestRequest,GetTaggingWorkRequestResponse> handler)
Description copied from interface:IdentityAsync
Gets details on a specified work request.The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in tagging service.
- Specified by:
getTaggingWorkRequest
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getTenancy
public Future<GetTenancyResponse> getTenancy(GetTenancyRequest request, AsyncHandler<GetTenancyRequest,GetTenancyResponse> handler)
Description copied from interface:IdentityAsync
Get the specified tenancy’s information.- Specified by:
getTenancy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getUser
public Future<GetUserResponse> getUser(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified user’s information.- Specified by:
getUser
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getUserGroupMembership
public Future<GetUserGroupMembershipResponse> getUserGroupMembership(GetUserGroupMembershipRequest request, AsyncHandler<GetUserGroupMembershipRequest,GetUserGroupMembershipResponse> handler)
Description copied from interface:IdentityAsync
Gets the specified UserGroupMembership’s information.- Specified by:
getUserGroupMembership
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getUserUIPasswordInformation
public Future<GetUserUIPasswordInformationResponse> getUserUIPasswordInformation(GetUserUIPasswordInformationRequest request, AsyncHandler<GetUserUIPasswordInformationRequest,GetUserUIPasswordInformationResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
getUserUIPasswordInformation
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
getWorkRequest
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
importStandardTags
public Future<ImportStandardTagsResponse> importStandardTags(ImportStandardTagsRequest request, AsyncHandler<ImportStandardTagsRequest,ImportStandardTagsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
importStandardTags
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listAllowedDomainLicenseTypes
public Future<ListAllowedDomainLicenseTypesResponse> listAllowedDomainLicenseTypes(ListAllowedDomainLicenseTypesRequest request, AsyncHandler<ListAllowedDomainLicenseTypesRequest,ListAllowedDomainLicenseTypesResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
listAllowedDomainLicenseTypes
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listApiKeys
public Future<ListApiKeysResponse> listApiKeys(ListApiKeysRequest request, AsyncHandler<ListApiKeysRequest,ListApiKeysResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listApiKeys
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listAuthTokens
public Future<ListAuthTokensResponse> listAuthTokens(ListAuthTokensRequest request, AsyncHandler<ListAuthTokensRequest,ListAuthTokensResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listAuthTokens
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listAvailabilityDomains
public Future<ListAvailabilityDomainsResponse> listAvailabilityDomains(ListAvailabilityDomainsRequest request, AsyncHandler<ListAvailabilityDomainsRequest,ListAvailabilityDomainsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listAvailabilityDomains
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBulkActionResourceTypes
public Future<ListBulkActionResourceTypesResponse> listBulkActionResourceTypes(ListBulkActionResourceTypesRequest request, AsyncHandler<ListBulkActionResourceTypesRequest,ListBulkActionResourceTypesResponse> handler)
Description copied from interface:IdentityAsync
Lists the resource-types supported by compartment bulk actions.Use this API to help you provide the correct resource-type information to the
bulkDeleteResources
andbulkMoveResources
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.- Specified by:
listBulkActionResourceTypes
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBulkEditTagsResourceTypes
public Future<ListBulkEditTagsResourceTypesResponse> listBulkEditTagsResourceTypes(ListBulkEditTagsResourceTypesRequest request, AsyncHandler<ListBulkEditTagsResourceTypesRequest,ListBulkEditTagsResourceTypesResponse> handler)
Description copied from interface:IdentityAsync
Lists the resource types that support bulk tag editing.- Specified by:
listBulkEditTagsResourceTypes
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listCompartments
public Future<ListCompartmentsResponse> listCompartments(ListCompartmentsRequest request, AsyncHandler<ListCompartmentsRequest,ListCompartmentsResponse> handler)
Description copied from interface:IdentityAsync
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).
- Specified by:
listCompartments
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listCostTrackingTags
public Future<ListCostTrackingTagsResponse> listCostTrackingTags(ListCostTrackingTagsRequest request, AsyncHandler<ListCostTrackingTagsRequest,ListCostTrackingTagsResponse> handler)
Description copied from interface:IdentityAsync
Lists all the tags enabled for cost-tracking in the specified tenancy.For information about cost-tracking tags, see Using Cost-tracking Tags.
- Specified by:
listCostTrackingTags
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listCustomerSecretKeys
public Future<ListCustomerSecretKeysResponse> listCustomerSecretKeys(ListCustomerSecretKeysRequest request, AsyncHandler<ListCustomerSecretKeysRequest,ListCustomerSecretKeysResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listCustomerSecretKeys
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDbCredentials
public Future<ListDbCredentialsResponse> listDbCredentials(ListDbCredentialsRequest request, AsyncHandler<ListDbCredentialsRequest,ListDbCredentialsResponse> handler)
Description copied from interface:IdentityAsync
Lists the DB credentials for the specified user.The returned object contains the credential’s OCID
- Specified by:
listDbCredentials
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDomains
public Future<ListDomainsResponse> listDomains(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResponse> handler)
Description copied from interface:IdentityAsync
(For tenancies that support identity domains) Lists all identity domains within a tenancy.- Specified by:
listDomains
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listDynamicGroups
public Future<ListDynamicGroupsResponse> listDynamicGroups(ListDynamicGroupsRequest request, AsyncHandler<ListDynamicGroupsRequest,ListDynamicGroupsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listDynamicGroups
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listFaultDomains
public Future<ListFaultDomainsResponse> listFaultDomains(ListFaultDomainsRequest request, AsyncHandler<ListFaultDomainsRequest,ListFaultDomainsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listFaultDomains
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listGroups
public Future<ListGroupsResponse> listGroups(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listGroups
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listIamWorkRequestErrors
public Future<ListIamWorkRequestErrorsResponse> listIamWorkRequestErrors(ListIamWorkRequestErrorsRequest request, AsyncHandler<ListIamWorkRequestErrorsRequest,ListIamWorkRequestErrorsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listIamWorkRequestErrors
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listIamWorkRequestLogs
public Future<ListIamWorkRequestLogsResponse> listIamWorkRequestLogs(ListIamWorkRequestLogsRequest request, AsyncHandler<ListIamWorkRequestLogsRequest,ListIamWorkRequestLogsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listIamWorkRequestLogs
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listIamWorkRequests
public Future<ListIamWorkRequestsResponse> listIamWorkRequests(ListIamWorkRequestsRequest request, AsyncHandler<ListIamWorkRequestsRequest,ListIamWorkRequestsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listIamWorkRequests
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listIdentityProviderGroups
public Future<ListIdentityProviderGroupsResponse> listIdentityProviderGroups(ListIdentityProviderGroupsRequest request, AsyncHandler<ListIdentityProviderGroupsRequest,ListIdentityProviderGroupsResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Lists the identity provider groups.
- Specified by:
listIdentityProviderGroups
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listIdentityProviders
public Future<ListIdentityProvidersResponse> listIdentityProviders(ListIdentityProvidersRequest request, AsyncHandler<ListIdentityProvidersRequest,ListIdentityProvidersResponse> handler)
Description copied from interface:IdentityAsync
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).
- Specified by:
listIdentityProviders
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listIdpGroupMappings
public Future<ListIdpGroupMappingsResponse> listIdpGroupMappings(ListIdpGroupMappingsRequest request, AsyncHandler<ListIdpGroupMappingsRequest,ListIdpGroupMappingsResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Lists the group mappings for the specified identity provider.
- Specified by:
listIdpGroupMappings
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listMfaTotpDevices
public Future<ListMfaTotpDevicesResponse> listMfaTotpDevices(ListMfaTotpDevicesRequest request, AsyncHandler<ListMfaTotpDevicesRequest,ListMfaTotpDevicesResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listMfaTotpDevices
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listNetworkSources
public Future<ListNetworkSourcesResponse> listNetworkSources(ListNetworkSourcesRequest request, AsyncHandler<ListNetworkSourcesRequest,ListNetworkSourcesResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listNetworkSources
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listOAuthClientCredentials
public Future<ListOAuthClientCredentialsResponse> listOAuthClientCredentials(ListOAuthClientCredentialsRequest request, AsyncHandler<ListOAuthClientCredentialsRequest,ListOAuthClientCredentialsResponse> handler)
Description copied from interface:IdentityAsync
List of Oauth tokens for the user- Specified by:
listOAuthClientCredentials
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listPolicies
public Future<ListPoliciesResponse> listPolicies(ListPoliciesRequest request, AsyncHandler<ListPoliciesRequest,ListPoliciesResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listPolicies
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listRegionSubscriptions
public Future<ListRegionSubscriptionsResponse> listRegionSubscriptions(ListRegionSubscriptionsRequest request, AsyncHandler<ListRegionSubscriptionsRequest,ListRegionSubscriptionsResponse> handler)
Description copied from interface:IdentityAsync
Lists the region subscriptions for the specified tenancy.- Specified by:
listRegionSubscriptions
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listRegions
public Future<ListRegionsResponse> listRegions(ListRegionsRequest request, AsyncHandler<ListRegionsRequest,ListRegionsResponse> handler)
Description copied from interface:IdentityAsync
Lists all the regions offered by Oracle Cloud Infrastructure.- Specified by:
listRegions
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listSmtpCredentials
public Future<ListSmtpCredentialsResponse> listSmtpCredentials(ListSmtpCredentialsRequest request, AsyncHandler<ListSmtpCredentialsRequest,ListSmtpCredentialsResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listSmtpCredentials
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listStandardTagNamespaces
public Future<ListStandardTagNamespacesResponse> listStandardTagNamespaces(ListStandardTagNamespacesRequest request, AsyncHandler<ListStandardTagNamespacesRequest,ListStandardTagNamespacesResponse> handler)
Description copied from interface:IdentityAsync
Lists available standard tag namespaces that users can create.- Specified by:
listStandardTagNamespaces
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listSwiftPasswords
public Future<ListSwiftPasswordsResponse> listSwiftPasswords(ListSwiftPasswordsRequest request, AsyncHandler<ListSwiftPasswordsRequest,ListSwiftPasswordsResponse> handler)
Description copied from interface:IdentityAsync
**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.
- Specified by:
listSwiftPasswords
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTagDefaults
public Future<ListTagDefaultsResponse> listTagDefaults(ListTagDefaultsRequest request, AsyncHandler<ListTagDefaultsRequest,ListTagDefaultsResponse> handler)
Description copied from interface:IdentityAsync
Lists the tag defaults for tag definitions in the specified compartment.- Specified by:
listTagDefaults
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTagNamespaces
public Future<ListTagNamespacesResponse> listTagNamespaces(ListTagNamespacesRequest request, AsyncHandler<ListTagNamespacesRequest,ListTagNamespacesResponse> handler)
Description copied from interface:IdentityAsync
Lists the tag namespaces in the specified compartment.- Specified by:
listTagNamespaces
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTaggingWorkRequestErrors
public Future<ListTaggingWorkRequestErrorsResponse> listTaggingWorkRequestErrors(ListTaggingWorkRequestErrorsRequest request, AsyncHandler<ListTaggingWorkRequestErrorsRequest,ListTaggingWorkRequestErrorsResponse> handler)
Description copied from interface:IdentityAsync
Gets the errors for a work request.- Specified by:
listTaggingWorkRequestErrors
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTaggingWorkRequestLogs
public Future<ListTaggingWorkRequestLogsResponse> listTaggingWorkRequestLogs(ListTaggingWorkRequestLogsRequest request, AsyncHandler<ListTaggingWorkRequestLogsRequest,ListTaggingWorkRequestLogsResponse> handler)
Description copied from interface:IdentityAsync
Gets the logs for a work request.- Specified by:
listTaggingWorkRequestLogs
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTaggingWorkRequests
public Future<ListTaggingWorkRequestsResponse> listTaggingWorkRequests(ListTaggingWorkRequestsRequest request, AsyncHandler<ListTaggingWorkRequestsRequest,ListTaggingWorkRequestsResponse> handler)
Description copied from interface:IdentityAsync
Lists the tagging work requests in compartment.- Specified by:
listTaggingWorkRequests
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listTags
public Future<ListTagsResponse> listTags(ListTagsRequest request, AsyncHandler<ListTagsRequest,ListTagsResponse> handler)
Description copied from interface:IdentityAsync
Lists the tag definitions in the specified tag namespace.- Specified by:
listTags
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listUserGroupMemberships
public Future<ListUserGroupMembershipsResponse> listUserGroupMemberships(ListUserGroupMembershipsRequest request, AsyncHandler<ListUserGroupMembershipsRequest,ListUserGroupMembershipsResponse> handler)
Description copied from interface:IdentityAsync
Lists theUserGroupMembership
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.
- Specified by:
listUserGroupMemberships
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listUsers
public Future<ListUsersResponse> listUsers(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
listUsers
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:IdentityAsync
Lists the work requests in compartment.- Specified by:
listWorkRequests
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
moveCompartment
public Future<MoveCompartmentResponse> moveCompartment(MoveCompartmentRequest request, AsyncHandler<MoveCompartmentRequest,MoveCompartmentResponse> handler)
Description copied from interface:IdentityAsync
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).
- Specified by:
moveCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
recoverCompartment
public Future<RecoverCompartmentResponse> recoverCompartment(RecoverCompartmentRequest request, AsyncHandler<RecoverCompartmentRequest,RecoverCompartmentResponse> handler)
Description copied from interface:IdentityAsync
Recover the compartment from DELETED state to ACTIVE state.- Specified by:
recoverCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeTagDefaultLock
public Future<RemoveTagDefaultLockResponse> removeTagDefaultLock(RemoveTagDefaultLockRequest request, AsyncHandler<RemoveTagDefaultLockRequest,RemoveTagDefaultLockResponse> handler)
Description copied from interface:IdentityAsync
Remove a resource lock from a tag default.- Specified by:
removeTagDefaultLock
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeTagNamespaceLock
public Future<RemoveTagNamespaceLockResponse> removeTagNamespaceLock(RemoveTagNamespaceLockRequest request, AsyncHandler<RemoveTagNamespaceLockRequest,RemoveTagNamespaceLockResponse> handler)
Description copied from interface:IdentityAsync
Remove a resource lock from a tag namespace.- Specified by:
removeTagNamespaceLock
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeUserFromGroup
public Future<RemoveUserFromGroupResponse> removeUserFromGroup(RemoveUserFromGroupRequest request, AsyncHandler<RemoveUserFromGroupRequest,RemoveUserFromGroupResponse> handler)
Description copied from interface:IdentityAsync
Removes a user from a group by deleting the correspondingUserGroupMembership
.- Specified by:
removeUserFromGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
resetIdpScimClient
public Future<ResetIdpScimClientResponse> resetIdpScimClient(ResetIdpScimClientRequest request, AsyncHandler<ResetIdpScimClientRequest,ResetIdpScimClientResponse> handler)
Description copied from interface:IdentityAsync
Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.- Specified by:
resetIdpScimClient
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateAuthToken
public Future<UpdateAuthTokenResponse> updateAuthToken(UpdateAuthTokenRequest request, AsyncHandler<UpdateAuthTokenRequest,UpdateAuthTokenResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified auth token’s description.- Specified by:
updateAuthToken
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateAuthenticationPolicy
public Future<UpdateAuthenticationPolicyResponse> updateAuthenticationPolicy(UpdateAuthenticationPolicyRequest request, AsyncHandler<UpdateAuthenticationPolicyRequest,UpdateAuthenticationPolicyResponse> handler)
Description copied from interface:IdentityAsync
Updates authentication policy for the specified tenancy.- Specified by:
updateAuthenticationPolicy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateCompartment
public Future<UpdateCompartmentResponse> updateCompartment(UpdateCompartmentRequest request, AsyncHandler<UpdateCompartmentRequest,UpdateCompartmentResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified compartment’s description or name.You can’t update the root compartment.
- Specified by:
updateCompartment
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateCustomerSecretKey
public Future<UpdateCustomerSecretKeyResponse> updateCustomerSecretKey(UpdateCustomerSecretKeyRequest request, AsyncHandler<UpdateCustomerSecretKeyRequest,UpdateCustomerSecretKeyResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified secret key’s description.- Specified by:
updateCustomerSecretKey
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateDomain
public Future<UpdateDomainResponse> updateDomain(UpdateDomainRequest request, AsyncHandler<UpdateDomainRequest,UpdateDomainResponse> handler)
Description copied from interface:IdentityAsync
(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.
- Specified by:
updateDomain
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateDynamicGroup
public Future<UpdateDynamicGroupResponse> updateDynamicGroup(UpdateDynamicGroupRequest request, AsyncHandler<UpdateDynamicGroupRequest,UpdateDynamicGroupResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified dynamic group.- Specified by:
updateDynamicGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateGroup
public Future<UpdateGroupResponse> updateGroup(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified group.- Specified by:
updateGroup
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateIdentityProvider
public Future<UpdateIdentityProviderResponse> updateIdentityProvider(UpdateIdentityProviderRequest request, AsyncHandler<UpdateIdentityProviderRequest,UpdateIdentityProviderResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Updates the specified identity provider.
- Specified by:
updateIdentityProvider
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateIdpGroupMapping
public Future<UpdateIdpGroupMappingResponse> updateIdpGroupMapping(UpdateIdpGroupMappingRequest request, AsyncHandler<UpdateIdpGroupMappingRequest,UpdateIdpGroupMappingResponse> handler)
Description copied from interface:IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.Updates the specified group mapping.
- Specified by:
updateIdpGroupMapping
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateNetworkSource
public Future<UpdateNetworkSourceResponse> updateNetworkSource(UpdateNetworkSourceRequest request, AsyncHandler<UpdateNetworkSourceRequest,UpdateNetworkSourceResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified network source.- Specified by:
updateNetworkSource
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateOAuthClientCredential
public Future<UpdateOAuthClientCredentialResponse> updateOAuthClientCredential(UpdateOAuthClientCredentialRequest request, AsyncHandler<UpdateOAuthClientCredentialRequest,UpdateOAuthClientCredentialResponse> handler)
Description copied from interface:IdentityAsync
Updates Oauth token for the user- Specified by:
updateOAuthClientCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updatePolicy
public Future<UpdatePolicyResponse> updatePolicy(UpdatePolicyRequest request, AsyncHandler<UpdatePolicyRequest,UpdatePolicyResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified policy.You can update the description or the policy statements themselves.
Policy changes take effect typically within 10 seconds.
- Specified by:
updatePolicy
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateSmtpCredential
public Future<UpdateSmtpCredentialResponse> updateSmtpCredential(UpdateSmtpCredentialRequest request, AsyncHandler<UpdateSmtpCredentialRequest,UpdateSmtpCredentialResponse> handler)
Description copied from interface:IdentityAsync
Updates the specified SMTP credential’s description.- Specified by:
updateSmtpCredential
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateSwiftPassword
public Future<UpdateSwiftPasswordResponse> updateSwiftPassword(UpdateSwiftPasswordRequest request, AsyncHandler<UpdateSwiftPasswordRequest,UpdateSwiftPasswordResponse> handler)
Description copied from interface:IdentityAsync
**Deprecated.Use
updateAuthToken
instead.**Updates the specified Swift password's description.
- Specified by:
updateSwiftPassword
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateTag
public Future<UpdateTagResponse> updateTag(UpdateTagRequest request, AsyncHandler<UpdateTagRequest,UpdateTagResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
updateTag
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateTagDefault
public Future<UpdateTagDefaultResponse> updateTagDefault(UpdateTagDefaultRequest request, AsyncHandler<UpdateTagDefaultRequest,UpdateTagDefaultResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
updateTagDefault
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateTagNamespace
public Future<UpdateTagNamespaceResponse> updateTagNamespace(UpdateTagNamespaceRequest request, AsyncHandler<UpdateTagNamespaceRequest,UpdateTagNamespaceResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
updateTagNamespace
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateUser
public Future<UpdateUserResponse> updateUser(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResponse> handler)
Description copied from interface:IdentityAsync
Updates the description of the specified user.- Specified by:
updateUser
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateUserCapabilities
public Future<UpdateUserCapabilitiesResponse> updateUserCapabilities(UpdateUserCapabilitiesRequest request, AsyncHandler<UpdateUserCapabilitiesRequest,UpdateUserCapabilitiesResponse> handler)
Description copied from interface:IdentityAsync
Updates the capabilities of the specified user.- Specified by:
updateUserCapabilities
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateUserState
public Future<UpdateUserStateResponse> updateUserState(UpdateUserStateRequest request, AsyncHandler<UpdateUserStateRequest,UpdateUserStateResponse> handler)
Description copied from interface:IdentityAsync
Updates the state of the specified user.- Specified by:
updateUserState
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
uploadApiKey
public Future<UploadApiKeyResponse> uploadApiKey(UploadApiKeyRequest request, AsyncHandler<UploadApiKeyRequest,UploadApiKeyResponse> handler)
Description copied from interface:IdentityAsync
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.
- Specified by:
uploadApiKey
in interfaceIdentityAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-