@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 an InputStream
, 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
Modifier and Type | Class and Description |
---|---|
static class |
IdentityAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and 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 and Description |
---|
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Identity.
public final String clientCommonLibraryVersion
@Deprecated public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.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)
@Deprecated public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see IdentityAsyncClient.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
public static IdentityAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
setRegion
in interface IdentityAsync
region
- The region of the service.public void setRegion(String regionId)
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 call setEndpoint
.
setRegion
in interface IdentityAsync
regionId
- The public region ID.public Future<ActivateDomainResponse> activateDomain(ActivateDomainRequest request, AsyncHandler<ActivateDomainRequest,ActivateDomainResponse> handler)
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.
activateDomain
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ActivateMfaTotpDeviceResponse> activateMfaTotpDevice(ActivateMfaTotpDeviceRequest request, AsyncHandler<ActivateMfaTotpDeviceRequest,ActivateMfaTotpDeviceResponse> handler)
IdentityAsync
Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.
activateMfaTotpDevice
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AddTagDefaultLockResponse> addTagDefaultLock(AddTagDefaultLockRequest request, AsyncHandler<AddTagDefaultLockRequest,AddTagDefaultLockResponse> handler)
IdentityAsync
Add a resource lock to a tag default.
addTagDefaultLock
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AddTagNamespaceLockResponse> addTagNamespaceLock(AddTagNamespaceLockRequest request, AsyncHandler<AddTagNamespaceLockRequest,AddTagNamespaceLockResponse> handler)
IdentityAsync
Add a resource lock to a tag namespace.
addTagNamespaceLock
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AddUserToGroupResponse> addUserToGroup(AddUserToGroupRequest request, AsyncHandler<AddUserToGroupRequest,AddUserToGroupResponse> handler)
IdentityAsync
Adds the specified user to the specified group and returns a UserGroupMembership
object
with its own OCID.
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
addUserToGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AssembleEffectiveTagSetResponse> assembleEffectiveTagSet(AssembleEffectiveTagSetRequest request, AsyncHandler<AssembleEffectiveTagSetRequest,AssembleEffectiveTagSetResponse> handler)
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.
assembleEffectiveTagSet
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<BulkDeleteResourcesResponse> bulkDeleteResources(BulkDeleteResourcesRequest request, AsyncHandler<BulkDeleteResourcesRequest,BulkDeleteResourcesResponse> handler)
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 the getWorkRequest
API to monitor the
status of the bulk action.
bulkDeleteResources
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<BulkDeleteTagsResponse> bulkDeleteTags(BulkDeleteTagsRequest request, AsyncHandler<BulkDeleteTagsRequest,BulkDeleteTagsResponse> handler)
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 the cascadeDeleteTagNamespace
operation until this process completes.
In order to delete tags, you must first retire the tags. Use updateTag
to retire a tag.
bulkDeleteTags
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<BulkEditTagsResponse> bulkEditTags(BulkEditTagsRequest request, AsyncHandler<BulkEditTagsRequest,BulkEditTagsResponse> handler)
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.
bulkEditTags
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<BulkMoveResourcesResponse> bulkMoveResources(BulkMoveResourcesRequest request, AsyncHandler<BulkMoveResourcesRequest,BulkMoveResourcesResponse> handler)
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 the getWorkRequest
API to monitor the
status of the bulk action.
bulkMoveResources
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CascadeDeleteTagNamespaceResponse> cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest request, AsyncHandler<CascadeDeleteTagNamespaceRequest,CascadeDeleteTagNamespaceResponse> handler)
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 the bulkDeleteTags
operation until
this process completes.
To delete a tag namespace, you must first retire it. Use updateTagNamespace
to
retire a tag namespace.
cascadeDeleteTagNamespace
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDomainCompartmentResponse> changeDomainCompartment(ChangeDomainCompartmentRequest request, AsyncHandler<ChangeDomainCompartmentRequest,ChangeDomainCompartmentResponse> handler)
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.
changeDomainCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDomainLicenseTypeResponse> changeDomainLicenseType(ChangeDomainLicenseTypeRequest request, AsyncHandler<ChangeDomainLicenseTypeRequest,ChangeDomainLicenseTypeResponse> handler)
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 requested
licenseType
must be allowed. To retrieve the allowed licenseType
for the identity domain,
use listAllowedDomainLicenseTypes
.
After you send your request, the `lifecycleDetails` of this identity domain is set to UPDATING. When the update of the identity domain completes, then the `lifecycleDetails` is set to null.
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.
changeDomainLicenseType
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeTagNamespaceCompartmentResponse> changeTagNamespaceCompartment(ChangeTagNamespaceCompartmentRequest request, AsyncHandler<ChangeTagNamespaceCompartmentRequest,ChangeTagNamespaceCompartmentResponse> handler)
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.cloud.oracle.com/Content/Identity/policyreference/iampolicyreference.htm).
Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
changeTagNamespaceCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateAuthTokenResponse> createAuthToken(CreateAuthTokenRequest request, AsyncHandler<CreateAuthTokenRequest,CreateAuthTokenResponse> handler)
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.
createAuthToken
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateCompartmentResponse> createCompartment(CreateCompartmentRequest request, AsyncHandler<CreateCompartmentRequest,CreateCompartmentResponse> handler)
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.cloud.oracle.com/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.cloud.oracle.com/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.
createCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateCustomerSecretKeyResponse> createCustomerSecretKey(CreateCustomerSecretKeyRequest request, AsyncHandler<CreateCustomerSecretKeyRequest,CreateCustomerSecretKeyResponse> handler)
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.
createCustomerSecretKey
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDbCredentialResponse> createDbCredential(CreateDbCredentialRequest request, AsyncHandler<CreateDbCredentialRequest,CreateDbCredentialResponse> handler)
IdentityAsync
Creates a new DB credential for the specified user.
createDbCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDomainResponse> createDomain(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResponse> handler)
IdentityAsync
(For tenancies that support identity domains) Creates a new identity domain in the tenancy
with the identity domain home in homeRegion
. After you send your request, the temporary
lifecycleState
of this identity domain is set to CREATING and lifecycleDetails
to
UPDATING. When creation of the identity domain completes, this identity domain’s
lifecycleState
is set to ACTIVE and lifecycleDetails
to null.
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.
After creating an `identity domain`, first make sure its `lifecycleState` changes from CREATING to ACTIVE before you use it.
createDomain
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDynamicGroupResponse> createDynamicGroup(CreateDynamicGroupRequest request, AsyncHandler<CreateDynamicGroupRequest,CreateDynamicGroupResponse> handler)
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.cloud.oracle.com/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.cloud.oracle.com/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.
createDynamicGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateGroupResponse> createGroup(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResponse> handler)
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.cloud.oracle.com/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.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm).
You must also specify a *description* for the group (although it can be an empty string).
It does not have to be unique, and you can change it anytime with updateGroup
.
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
After creating the group, you need to put users in it and write policies for it. See
addUserToGroup
and createPolicy
.
createGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateIdentityProviderResponse> createIdentityProvider(CreateIdentityProviderRequest request, AsyncHandler<CreateIdentityProviderRequest,CreateIdentityProviderResponse> handler)
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.cloud.oracle.com/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.cloud.oracle.com/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.
createIdentityProvider
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateIdpGroupMappingResponse> createIdpGroupMapping(CreateIdpGroupMappingRequest request, AsyncHandler<CreateIdpGroupMappingRequest,CreateIdpGroupMappingResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Creates a single mapping between an IdP group and an IAM Service Group
.
createIdpGroupMapping
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateMfaTotpDeviceResponse> createMfaTotpDevice(CreateMfaTotpDeviceRequest request, AsyncHandler<CreateMfaTotpDeviceRequest,CreateMfaTotpDeviceResponse> handler)
IdentityAsync
Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.
createMfaTotpDevice
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateNetworkSourceResponse> createNetworkSource(CreateNetworkSourceRequest request, AsyncHandler<CreateNetworkSourceRequest,CreateNetworkSourceResponse> handler)
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.cloud.oracle.com/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.cloud.oracle.com/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.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).
createNetworkSource
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateOAuthClientCredentialResponse> createOAuthClientCredential(CreateOAuthClientCredentialRequest request, AsyncHandler<CreateOAuthClientCredentialRequest,CreateOAuthClientCredentialResponse> handler)
IdentityAsync
Creates Oauth token for the user
createOAuthClientCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateOrResetUIPasswordResponse> createOrResetUIPassword(CreateOrResetUIPasswordRequest request, AsyncHandler<CreateOrResetUIPasswordRequest,CreateOrResetUIPasswordResponse> handler)
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
).
createOrResetUIPassword
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreatePolicyResponse> createPolicy(CreatePolicyRequest request, AsyncHandler<CreatePolicyRequest,CreatePolicyResponse> handler)
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.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm) and [Common Policies](https://docs.cloud.oracle.com/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.
createPolicy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateRegionSubscriptionResponse> createRegionSubscription(CreateRegionSubscriptionRequest request, AsyncHandler<CreateRegionSubscriptionRequest,CreateRegionSubscriptionResponse> handler)
IdentityAsync
Creates a subscription to a region for a tenancy.
createRegionSubscription
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateSmtpCredentialResponse> createSmtpCredential(CreateSmtpCredentialRequest request, AsyncHandler<CreateSmtpCredentialRequest,CreateSmtpCredentialResponse> handler)
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
.
createSmtpCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateSwiftPasswordResponse> createSwiftPassword(CreateSwiftPasswordRequest request, AsyncHandler<CreateSwiftPasswordRequest,CreateSwiftPasswordResponse> handler)
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.cloud.oracle.com/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.
createSwiftPassword
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateTagResponse> createTag(CreateTagRequest request, AsyncHandler<CreateTagRequest,CreateTagResponse> handler)
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
.
createTag
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateTagDefaultResponse> createTagDefault(CreateTagDefaultRequest request, AsyncHandler<CreateTagDefaultRequest,CreateTagDefaultResponse> handler)
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.
createTagDefault
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateTagNamespaceResponse> createTagNamespace(CreateTagNamespaceRequest request, AsyncHandler<CreateTagNamespaceRequest,CreateTagNamespaceResponse> handler)
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
.
createTagNamespace
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateUserResponse> createUser(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResponse> handler)
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.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a *name* for the user, which must be unique across all users in your tenancy and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, underscores, +, and @. If you specify a name that's already in use, you'll get a 409 error. This name will be the user's login to the Console. You might want to pick a name that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses. If you delete a user and then create a new user with the same name, they'll be considered different users because they have different OCIDs.
You must also specify a *description* for the user (although it can be an empty string).
It does not have to be unique, and you can change it anytime with updateUser
. You can use the field to
provide the user's full name, a description, a nickname, or other information to generally
identify the user.
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
A new user has no permissions until you place the user in one or more groups (see addUserToGroup
). If the user
needs to access the Console, you need to provide the user a password (see createOrResetUIPassword
). If the user needs to access the Oracle Cloud Infrastructure REST
API, you need to upload a public API signing key for that user (see [Required Keys and
OCIDs](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm) and also uploadApiKey
).
*Important:** Make sure to inform the new user which compartment(s) they have access to.
createUser
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeactivateDomainResponse> deactivateDomain(DeactivateDomainRequest request, AsyncHandler<DeactivateDomainRequest,DeactivateDomainResponse> handler)
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.
deactivateDomain
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteApiKeyResponse> deleteApiKey(DeleteApiKeyRequest request, AsyncHandler<DeleteApiKeyRequest,DeleteApiKeyResponse> handler)
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.
deleteApiKey
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteAuthTokenResponse> deleteAuthToken(DeleteAuthTokenRequest request, AsyncHandler<DeleteAuthTokenRequest,DeleteAuthTokenResponse> handler)
IdentityAsync
Deletes the specified auth token for the specified user.
deleteAuthToken
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteCompartmentResponse> deleteCompartment(DeleteCompartmentRequest request, AsyncHandler<DeleteCompartmentRequest,DeleteCompartmentResponse> handler)
IdentityAsync
Deletes the specified compartment. The compartment must be empty.
deleteCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteCustomerSecretKeyResponse> deleteCustomerSecretKey(DeleteCustomerSecretKeyRequest request, AsyncHandler<DeleteCustomerSecretKeyRequest,DeleteCustomerSecretKeyResponse> handler)
IdentityAsync
Deletes the specified secret key for the specified user.
deleteCustomerSecretKey
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDbCredentialResponse> deleteDbCredential(DeleteDbCredentialRequest request, AsyncHandler<DeleteDbCredentialRequest,DeleteDbCredentialResponse> handler)
IdentityAsync
Deletes the specified DB credential for the specified user.
deleteDbCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDomainResponse> deleteDomain(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResponse> handler)
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.
deleteDomain
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDynamicGroupResponse> deleteDynamicGroup(DeleteDynamicGroupRequest request, AsyncHandler<DeleteDynamicGroupRequest,DeleteDynamicGroupResponse> handler)
IdentityAsync
Deletes the specified dynamic group.
deleteDynamicGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteGroupResponse> deleteGroup(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResponse> handler)
IdentityAsync
Deletes the specified group. The group must be empty.
deleteGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteIdentityProviderResponse> deleteIdentityProvider(DeleteIdentityProviderRequest request, AsyncHandler<DeleteIdentityProviderRequest,DeleteIdentityProviderResponse> handler)
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
).
deleteIdentityProvider
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteIdpGroupMappingResponse> deleteIdpGroupMapping(DeleteIdpGroupMappingRequest request, AsyncHandler<DeleteIdpGroupMappingRequest,DeleteIdpGroupMappingResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Deletes the specified group mapping.
deleteIdpGroupMapping
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteMfaTotpDeviceResponse> deleteMfaTotpDevice(DeleteMfaTotpDeviceRequest request, AsyncHandler<DeleteMfaTotpDeviceRequest,DeleteMfaTotpDeviceResponse> handler)
IdentityAsync
Deletes the specified MFA TOTP device for the specified user.
deleteMfaTotpDevice
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteNetworkSourceResponse> deleteNetworkSource(DeleteNetworkSourceRequest request, AsyncHandler<DeleteNetworkSourceRequest,DeleteNetworkSourceResponse> handler)
IdentityAsync
Deletes the specified network source.
deleteNetworkSource
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteOAuthClientCredentialResponse> deleteOAuthClientCredential(DeleteOAuthClientCredentialRequest request, AsyncHandler<DeleteOAuthClientCredentialRequest,DeleteOAuthClientCredentialResponse> handler)
IdentityAsync
Delete Oauth token for the user
deleteOAuthClientCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeletePolicyResponse> deletePolicy(DeletePolicyRequest request, AsyncHandler<DeletePolicyRequest,DeletePolicyResponse> handler)
IdentityAsync
Deletes the specified policy. The deletion takes effect typically within 10 seconds.
deletePolicy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteSmtpCredentialResponse> deleteSmtpCredential(DeleteSmtpCredentialRequest request, AsyncHandler<DeleteSmtpCredentialRequest,DeleteSmtpCredentialResponse> handler)
IdentityAsync
Deletes the specified SMTP credential for the specified user.
deleteSmtpCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteSwiftPasswordResponse> deleteSwiftPassword(DeleteSwiftPasswordRequest request, AsyncHandler<DeleteSwiftPasswordRequest,DeleteSwiftPasswordResponse> handler)
IdentityAsync
Deprecated. Use deleteAuthToken
instead.
Deletes the specified Swift password for the specified user.
deleteSwiftPassword
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteTagResponse> deleteTag(DeleteTagRequest request, AsyncHandler<DeleteTagRequest,DeleteTagResponse> handler)
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 the cascadeDeleteTagNamespace
operation until this process completes.
To delete a tag, you must first retire it. Use updateTag
to retire a tag.
deleteTag
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteTagDefaultResponse> deleteTagDefault(DeleteTagDefaultRequest request, AsyncHandler<DeleteTagDefaultRequest,DeleteTagDefaultResponse> handler)
IdentityAsync
Deletes the the specified tag default.
deleteTagDefault
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteTagNamespaceResponse> deleteTagNamespace(DeleteTagNamespaceRequest request, AsyncHandler<DeleteTagNamespaceRequest,DeleteTagNamespaceResponse> handler)
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.
deleteTagNamespace
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteUserResponse> deleteUser(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResponse> handler)
IdentityAsync
Deletes the specified user. The user must not be in any groups.
deleteUser
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<EnableReplicationToRegionResponse> enableReplicationToRegion(EnableReplicationToRegionRequest request, AsyncHandler<EnableReplicationToRegionRequest,EnableReplicationToRegionResponse> handler)
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.
enableReplicationToRegion
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GenerateTotpSeedResponse> generateTotpSeed(GenerateTotpSeedRequest request, AsyncHandler<GenerateTotpSeedRequest,GenerateTotpSeedResponse> handler)
IdentityAsync
Generate seed for the MFA TOTP device.
generateTotpSeed
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetAuthenticationPolicyResponse> getAuthenticationPolicy(GetAuthenticationPolicyRequest request, AsyncHandler<GetAuthenticationPolicyRequest,GetAuthenticationPolicyResponse> handler)
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).
getAuthenticationPolicy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetCompartmentResponse> getCompartment(GetCompartmentRequest request, AsyncHandler<GetCompartmentRequest,GetCompartmentResponse> handler)
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 the listVolumes
operation in Cloud Block Storage.
getCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDomainResponse> getDomain(GetDomainRequest request, AsyncHandler<GetDomainRequest,GetDomainResponse> handler)
IdentityAsync
(For tenancies that support identity domains) Gets the specified identity domain’s information.
getDomain
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDynamicGroupResponse> getDynamicGroup(GetDynamicGroupRequest request, AsyncHandler<GetDynamicGroupRequest,GetDynamicGroupResponse> handler)
IdentityAsync
Gets the specified dynamic group’s information.
getDynamicGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetGroupResponse> getGroup(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResponse> handler)
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.
getGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetIamWorkRequestResponse> getIamWorkRequest(GetIamWorkRequestRequest request, AsyncHandler<GetIamWorkRequestRequest,GetIamWorkRequestResponse> handler)
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.
getIamWorkRequest
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetIdentityProviderResponse> getIdentityProvider(GetIdentityProviderRequest request, AsyncHandler<GetIdentityProviderRequest,GetIdentityProviderResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Gets the specified identity provider's information.
getIdentityProvider
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetIdpGroupMappingResponse> getIdpGroupMapping(GetIdpGroupMappingRequest request, AsyncHandler<GetIdpGroupMappingRequest,GetIdpGroupMappingResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Gets the specified group mapping.
getIdpGroupMapping
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetMfaTotpDeviceResponse> getMfaTotpDevice(GetMfaTotpDeviceRequest request, AsyncHandler<GetMfaTotpDeviceRequest,GetMfaTotpDeviceResponse> handler)
IdentityAsync
Get the specified MFA TOTP device for the specified user.
getMfaTotpDevice
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetNetworkSourceResponse> getNetworkSource(GetNetworkSourceRequest request, AsyncHandler<GetNetworkSourceRequest,GetNetworkSourceResponse> handler)
IdentityAsync
Gets the specified network source’s information.
getNetworkSource
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetPolicyResponse> getPolicy(GetPolicyRequest request, AsyncHandler<GetPolicyRequest,GetPolicyResponse> handler)
IdentityAsync
Gets the specified policy’s information.
getPolicy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetStandardTagTemplateResponse> getStandardTagTemplate(GetStandardTagTemplateRequest request, AsyncHandler<GetStandardTagTemplateRequest,GetStandardTagTemplateResponse> handler)
IdentityAsync
Retrieve the standard tag namespace template given the standard tag namespace name.
getStandardTagTemplate
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetTagResponse> getTag(GetTagRequest request, AsyncHandler<GetTagRequest,GetTagResponse> handler)
IdentityAsync
Gets the specified tag’s information.
getTag
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetTagDefaultResponse> getTagDefault(GetTagDefaultRequest request, AsyncHandler<GetTagDefaultRequest,GetTagDefaultResponse> handler)
IdentityAsync
Retrieves the specified tag default.
getTagDefault
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetTagNamespaceResponse> getTagNamespace(GetTagNamespaceRequest request, AsyncHandler<GetTagNamespaceRequest,GetTagNamespaceResponse> handler)
IdentityAsync
Gets the specified tag namespace’s information.
getTagNamespace
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetTaggingWorkRequestResponse> getTaggingWorkRequest(GetTaggingWorkRequestRequest request, AsyncHandler<GetTaggingWorkRequestRequest,GetTaggingWorkRequestResponse> handler)
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.
getTaggingWorkRequest
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetTenancyResponse> getTenancy(GetTenancyRequest request, AsyncHandler<GetTenancyRequest,GetTenancyResponse> handler)
IdentityAsync
Get the specified tenancy’s information.
getTenancy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetUserResponse> getUser(GetUserRequest request, AsyncHandler<GetUserRequest,GetUserResponse> handler)
IdentityAsync
Gets the specified user’s information.
getUser
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetUserGroupMembershipResponse> getUserGroupMembership(GetUserGroupMembershipRequest request, AsyncHandler<GetUserGroupMembershipRequest,GetUserGroupMembershipResponse> handler)
IdentityAsync
Gets the specified UserGroupMembership’s information.
getUserGroupMembership
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetUserUIPasswordInformationResponse> getUserUIPasswordInformation(GetUserUIPasswordInformationRequest request, AsyncHandler<GetUserUIPasswordInformationRequest,GetUserUIPasswordInformationResponse> handler)
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.
getUserUIPasswordInformation
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
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.
getWorkRequest
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ImportStandardTagsResponse> importStandardTags(ImportStandardTagsRequest request, AsyncHandler<ImportStandardTagsRequest,ImportStandardTagsResponse> handler)
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.
importStandardTags
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAllowedDomainLicenseTypesResponse> listAllowedDomainLicenseTypes(ListAllowedDomainLicenseTypesRequest request, AsyncHandler<ListAllowedDomainLicenseTypesRequest,ListAllowedDomainLicenseTypesResponse> handler)
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.
listAllowedDomainLicenseTypes
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListApiKeysResponse> listApiKeys(ListApiKeysRequest request, AsyncHandler<ListApiKeysRequest,ListApiKeysResponse> handler)
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.
listApiKeys
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAuthTokensResponse> listAuthTokens(ListAuthTokensRequest request, AsyncHandler<ListAuthTokensRequest,ListAuthTokensResponse> handler)
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.
listAuthTokens
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAvailabilityDomainsResponse> listAvailabilityDomains(ListAvailabilityDomainsRequest request, AsyncHandler<ListAvailabilityDomainsRequest,ListAvailabilityDomainsResponse> handler)
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.
listAvailabilityDomains
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBulkActionResourceTypesResponse> listBulkActionResourceTypes(ListBulkActionResourceTypesRequest request, AsyncHandler<ListBulkActionResourceTypesRequest,ListBulkActionResourceTypesResponse> handler)
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
and
bulkMoveResources
operations. The returned list of resource-types provides the appropriate resource-type names
to use with the bulk action operations along with the type of identifying information you’ll
need to provide for each resource-type. Most resource-types just require an
OCID to identify a
specific resource, but some resource-types, such as buckets, require you to provide other
identifying information.
listBulkActionResourceTypes
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListBulkEditTagsResourceTypesResponse> listBulkEditTagsResourceTypes(ListBulkEditTagsResourceTypesRequest request, AsyncHandler<ListBulkEditTagsResourceTypesRequest,ListBulkEditTagsResourceTypesResponse> handler)
IdentityAsync
Lists the resource types that support bulk tag editing.
listBulkEditTagsResourceTypes
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListCompartmentsResponse> listCompartments(ListCompartmentsRequest request, AsyncHandler<ListCompartmentsRequest,ListCompartmentsResponse> handler)
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.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
listCompartments
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListCostTrackingTagsResponse> listCostTrackingTags(ListCostTrackingTagsRequest request, AsyncHandler<ListCostTrackingTagsRequest,ListCostTrackingTagsResponse> handler)
IdentityAsync
Lists all the tags enabled for cost-tracking in the specified tenancy. For information about cost-tracking tags, see Using Cost-tracking Tags.
listCostTrackingTags
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListCustomerSecretKeysResponse> listCustomerSecretKeys(ListCustomerSecretKeysRequest request, AsyncHandler<ListCustomerSecretKeysRequest,ListCustomerSecretKeysResponse> handler)
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.
listCustomerSecretKeys
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDbCredentialsResponse> listDbCredentials(ListDbCredentialsRequest request, AsyncHandler<ListDbCredentialsRequest,ListDbCredentialsResponse> handler)
IdentityAsync
Lists the DB credentials for the specified user. The returned object contains the credential’s OCID
listDbCredentials
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDomainsResponse> listDomains(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResponse> handler)
IdentityAsync
(For tenancies that support identity domains) Lists all identity domains within a tenancy.
listDomains
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDynamicGroupsResponse> listDynamicGroups(ListDynamicGroupsRequest request, AsyncHandler<ListDynamicGroupsRequest,ListDynamicGroupsResponse> handler)
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.
listDynamicGroups
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListFaultDomainsResponse> listFaultDomains(ListFaultDomainsRequest request, AsyncHandler<ListFaultDomainsRequest,ListFaultDomainsResponse> handler)
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.
listFaultDomains
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListGroupsResponse> listGroups(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResponse> handler)
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.
listGroups
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIamWorkRequestErrorsResponse> listIamWorkRequestErrors(ListIamWorkRequestErrorsRequest request, AsyncHandler<ListIamWorkRequestErrorsRequest,ListIamWorkRequestErrorsResponse> handler)
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.
listIamWorkRequestErrors
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIamWorkRequestLogsResponse> listIamWorkRequestLogs(ListIamWorkRequestLogsRequest request, AsyncHandler<ListIamWorkRequestLogsRequest,ListIamWorkRequestLogsResponse> handler)
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.
listIamWorkRequestLogs
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIamWorkRequestsResponse> listIamWorkRequests(ListIamWorkRequestsRequest request, AsyncHandler<ListIamWorkRequestsRequest,ListIamWorkRequestsResponse> handler)
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.
listIamWorkRequests
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIdentityProviderGroupsResponse> listIdentityProviderGroups(ListIdentityProviderGroupsRequest request, AsyncHandler<ListIdentityProviderGroupsRequest,ListIdentityProviderGroupsResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Lists the identity provider groups.
listIdentityProviderGroups
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIdentityProvidersResponse> listIdentityProviders(ListIdentityProvidersRequest request, AsyncHandler<ListIdentityProvidersRequest,ListIdentityProvidersResponse> handler)
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.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
listIdentityProviders
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListIdpGroupMappingsResponse> listIdpGroupMappings(ListIdpGroupMappingsRequest request, AsyncHandler<ListIdpGroupMappingsRequest,ListIdpGroupMappingsResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Lists the group mappings for the specified identity provider.
listIdpGroupMappings
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListMfaTotpDevicesResponse> listMfaTotpDevices(ListMfaTotpDevicesRequest request, AsyncHandler<ListMfaTotpDevicesRequest,ListMfaTotpDevicesResponse> handler)
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.
listMfaTotpDevices
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListNetworkSourcesResponse> listNetworkSources(ListNetworkSourcesRequest request, AsyncHandler<ListNetworkSourcesRequest,ListNetworkSourcesResponse> handler)
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.
listNetworkSources
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListOAuthClientCredentialsResponse> listOAuthClientCredentials(ListOAuthClientCredentialsRequest request, AsyncHandler<ListOAuthClientCredentialsRequest,ListOAuthClientCredentialsResponse> handler)
IdentityAsync
List of Oauth tokens for the user
listOAuthClientCredentials
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListPoliciesResponse> listPolicies(ListPoliciesRequest request, AsyncHandler<ListPoliciesRequest,ListPoliciesResponse> handler)
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.
listPolicies
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListRegionSubscriptionsResponse> listRegionSubscriptions(ListRegionSubscriptionsRequest request, AsyncHandler<ListRegionSubscriptionsRequest,ListRegionSubscriptionsResponse> handler)
IdentityAsync
Lists the region subscriptions for the specified tenancy.
listRegionSubscriptions
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListRegionsResponse> listRegions(ListRegionsRequest request, AsyncHandler<ListRegionsRequest,ListRegionsResponse> handler)
IdentityAsync
Lists all the regions offered by Oracle Cloud Infrastructure.
listRegions
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSmtpCredentialsResponse> listSmtpCredentials(ListSmtpCredentialsRequest request, AsyncHandler<ListSmtpCredentialsRequest,ListSmtpCredentialsResponse> handler)
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.
listSmtpCredentials
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListStandardTagNamespacesResponse> listStandardTagNamespaces(ListStandardTagNamespacesRequest request, AsyncHandler<ListStandardTagNamespacesRequest,ListStandardTagNamespacesResponse> handler)
IdentityAsync
Lists available standard tag namespaces that users can create.
listStandardTagNamespaces
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSwiftPasswordsResponse> listSwiftPasswords(ListSwiftPasswordsRequest request, AsyncHandler<ListSwiftPasswordsRequest,ListSwiftPasswordsResponse> handler)
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.
listSwiftPasswords
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTagDefaultsResponse> listTagDefaults(ListTagDefaultsRequest request, AsyncHandler<ListTagDefaultsRequest,ListTagDefaultsResponse> handler)
IdentityAsync
Lists the tag defaults for tag definitions in the specified compartment.
listTagDefaults
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTagNamespacesResponse> listTagNamespaces(ListTagNamespacesRequest request, AsyncHandler<ListTagNamespacesRequest,ListTagNamespacesResponse> handler)
IdentityAsync
Lists the tag namespaces in the specified compartment.
listTagNamespaces
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTaggingWorkRequestErrorsResponse> listTaggingWorkRequestErrors(ListTaggingWorkRequestErrorsRequest request, AsyncHandler<ListTaggingWorkRequestErrorsRequest,ListTaggingWorkRequestErrorsResponse> handler)
IdentityAsync
Gets the errors for a work request.
listTaggingWorkRequestErrors
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTaggingWorkRequestLogsResponse> listTaggingWorkRequestLogs(ListTaggingWorkRequestLogsRequest request, AsyncHandler<ListTaggingWorkRequestLogsRequest,ListTaggingWorkRequestLogsResponse> handler)
IdentityAsync
Gets the logs for a work request.
listTaggingWorkRequestLogs
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTaggingWorkRequestsResponse> listTaggingWorkRequests(ListTaggingWorkRequestsRequest request, AsyncHandler<ListTaggingWorkRequestsRequest,ListTaggingWorkRequestsResponse> handler)
IdentityAsync
Lists the tagging work requests in compartment.
listTaggingWorkRequests
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListTagsResponse> listTags(ListTagsRequest request, AsyncHandler<ListTagsRequest,ListTagsResponse> handler)
IdentityAsync
Lists the tag definitions in the specified tag namespace.
listTags
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListUserGroupMembershipsResponse> listUserGroupMemberships(ListUserGroupMembershipsRequest request, AsyncHandler<ListUserGroupMembershipsRequest,ListUserGroupMembershipsResponse> handler)
IdentityAsync
Lists the UserGroupMembership
objects in your tenancy. You must specify your tenancy’s OCID
as the value for the compartment ID (see Where to Get the Tenancy’s OCID and User’s
OCID). You must
also then filter the list in one of these ways:
- You can limit the results to just the memberships for a given user by specifying a `userId`. - Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`. - You can set both the `userId` and `groupId` to determine if the specified user is in the specified group. If the answer is no, the response is an empty list. - Although`userId` and `groupId` are not individually required, you must set one of them.
listUserGroupMemberships
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListUsersResponse> listUsers(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResponse> handler)
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.
listUsers
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
IdentityAsync
Lists the work requests in compartment.
listWorkRequests
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<MoveCompartmentResponse> moveCompartment(MoveCompartmentRequest request, AsyncHandler<MoveCompartmentRequest,MoveCompartmentResponse> handler)
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.cloud.oracle.com/Content/Identity/compartments/managingcompartments.htm#MoveCompartment).
moveCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RecoverCompartmentResponse> recoverCompartment(RecoverCompartmentRequest request, AsyncHandler<RecoverCompartmentRequest,RecoverCompartmentResponse> handler)
IdentityAsync
Recover the compartment from DELETED state to ACTIVE state.
recoverCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveTagDefaultLockResponse> removeTagDefaultLock(RemoveTagDefaultLockRequest request, AsyncHandler<RemoveTagDefaultLockRequest,RemoveTagDefaultLockResponse> handler)
IdentityAsync
Remove a resource lock from a tag default.
removeTagDefaultLock
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveTagNamespaceLockResponse> removeTagNamespaceLock(RemoveTagNamespaceLockRequest request, AsyncHandler<RemoveTagNamespaceLockRequest,RemoveTagNamespaceLockResponse> handler)
IdentityAsync
Remove a resource lock from a tag namespace.
removeTagNamespaceLock
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveUserFromGroupResponse> removeUserFromGroup(RemoveUserFromGroupRequest request, AsyncHandler<RemoveUserFromGroupRequest,RemoveUserFromGroupResponse> handler)
IdentityAsync
Removes a user from a group by deleting the corresponding UserGroupMembership
.
removeUserFromGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ResetIdpScimClientResponse> resetIdpScimClient(ResetIdpScimClientRequest request, AsyncHandler<ResetIdpScimClientRequest,ResetIdpScimClientResponse> handler)
IdentityAsync
Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
resetIdpScimClient
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateAuthTokenResponse> updateAuthToken(UpdateAuthTokenRequest request, AsyncHandler<UpdateAuthTokenRequest,UpdateAuthTokenResponse> handler)
IdentityAsync
Updates the specified auth token’s description.
updateAuthToken
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateAuthenticationPolicyResponse> updateAuthenticationPolicy(UpdateAuthenticationPolicyRequest request, AsyncHandler<UpdateAuthenticationPolicyRequest,UpdateAuthenticationPolicyResponse> handler)
IdentityAsync
Updates authentication policy for the specified tenancy.
updateAuthenticationPolicy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateCompartmentResponse> updateCompartment(UpdateCompartmentRequest request, AsyncHandler<UpdateCompartmentRequest,UpdateCompartmentResponse> handler)
IdentityAsync
Updates the specified compartment’s description or name. You can’t update the root compartment.
updateCompartment
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateCustomerSecretKeyResponse> updateCustomerSecretKey(UpdateCustomerSecretKeyRequest request, AsyncHandler<UpdateCustomerSecretKeyRequest,UpdateCustomerSecretKeyResponse> handler)
IdentityAsync
Updates the specified secret key’s description.
updateCustomerSecretKey
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDomainResponse> updateDomain(UpdateDomainRequest request, AsyncHandler<UpdateDomainRequest,UpdateDomainResponse> handler)
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.
updateDomain
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDynamicGroupResponse> updateDynamicGroup(UpdateDynamicGroupRequest request, AsyncHandler<UpdateDynamicGroupRequest,UpdateDynamicGroupResponse> handler)
IdentityAsync
Updates the specified dynamic group.
updateDynamicGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateGroupResponse> updateGroup(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResponse> handler)
IdentityAsync
Updates the specified group.
updateGroup
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateIdentityProviderResponse> updateIdentityProvider(UpdateIdentityProviderRequest request, AsyncHandler<UpdateIdentityProviderRequest,UpdateIdentityProviderResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Updates the specified identity provider.
updateIdentityProvider
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateIdpGroupMappingResponse> updateIdpGroupMapping(UpdateIdpGroupMappingRequest request, AsyncHandler<UpdateIdpGroupMappingRequest,UpdateIdpGroupMappingResponse> handler)
IdentityAsync
Deprecated. For more information, see Deprecated IAM Service APIs.
Updates the specified group mapping.
updateIdpGroupMapping
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateNetworkSourceResponse> updateNetworkSource(UpdateNetworkSourceRequest request, AsyncHandler<UpdateNetworkSourceRequest,UpdateNetworkSourceResponse> handler)
IdentityAsync
Updates the specified network source.
updateNetworkSource
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateOAuthClientCredentialResponse> updateOAuthClientCredential(UpdateOAuthClientCredentialRequest request, AsyncHandler<UpdateOAuthClientCredentialRequest,UpdateOAuthClientCredentialResponse> handler)
IdentityAsync
Updates Oauth token for the user
updateOAuthClientCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdatePolicyResponse> updatePolicy(UpdatePolicyRequest request, AsyncHandler<UpdatePolicyRequest,UpdatePolicyResponse> handler)
IdentityAsync
Updates the specified policy. You can update the description or the policy statements themselves.
Policy changes take effect typically within 10 seconds.
updatePolicy
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateSmtpCredentialResponse> updateSmtpCredential(UpdateSmtpCredentialRequest request, AsyncHandler<UpdateSmtpCredentialRequest,UpdateSmtpCredentialResponse> handler)
IdentityAsync
Updates the specified SMTP credential’s description.
updateSmtpCredential
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateSwiftPasswordResponse> updateSwiftPassword(UpdateSwiftPasswordRequest request, AsyncHandler<UpdateSwiftPasswordRequest,UpdateSwiftPasswordResponse> handler)
IdentityAsync
Deprecated. Use updateAuthToken
instead.
Updates the specified Swift password's description.
updateSwiftPassword
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateTagResponse> updateTag(UpdateTagRequest request, AsyncHandler<UpdateTagRequest,UpdateTagResponse> handler)
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.
updateTag
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateTagDefaultResponse> updateTagDefault(UpdateTagDefaultRequest request, AsyncHandler<UpdateTagDefaultRequest,UpdateTagDefaultResponse> handler)
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.
updateTagDefault
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateTagNamespaceResponse> updateTagNamespace(UpdateTagNamespaceRequest request, AsyncHandler<UpdateTagNamespaceRequest,UpdateTagNamespaceResponse> handler)
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.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
You can't add a namespace with the same name as a retired namespace in the same tenancy.
updateTagNamespace
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateUserResponse> updateUser(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResponse> handler)
IdentityAsync
Updates the description of the specified user.
updateUser
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateUserCapabilitiesResponse> updateUserCapabilities(UpdateUserCapabilitiesRequest request, AsyncHandler<UpdateUserCapabilitiesRequest,UpdateUserCapabilitiesResponse> handler)
IdentityAsync
Updates the capabilities of the specified user.
updateUserCapabilities
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateUserStateResponse> updateUserState(UpdateUserStateRequest request, AsyncHandler<UpdateUserStateRequest,UpdateUserStateResponse> handler)
IdentityAsync
Updates the state of the specified user.
updateUserState
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UploadApiKeyResponse> uploadApiKey(UploadApiKeyRequest request, AsyncHandler<UploadApiKeyRequest,UploadApiKeyResponse> handler)
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.
uploadApiKey
in interface IdentityAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
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)
Copyright © 2016–2024. All rights reserved.