@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class IdentityAsyncClient extends Object 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 |
---|---|
static Service |
SERVICE
Service instance for Identity.
|
Constructor and Description |
---|
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for Identity.
public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public IdentityAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public IdentityAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public static IdentityAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
IdentityAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface IdentityAsync
endpoint
- The endpoint of the serice.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 void close()
close
in interface AutoCloseable
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<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<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.
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.
Important:** Compartments cannot be deleted.
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.
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.
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. 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<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.
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.
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.
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.
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
Creates a new identity provider in your tenancy. For more information, see Identity Providers and Federation.
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.
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
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<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.
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 Getting 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 and Common Policies.
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.
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.
You must specify either the OCID or the name of the tag namespace that will contain this tag definition.
You must also 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.
You must also specify a description for the tag. It does not have to be unique, and you can change it with updateTag
.
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.
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
.
Tag namespaces cannot be deleted, but they can be retired. See Retiring Key Definitions and Namespace Definitions for more information.
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 the IAM Service.
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.
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 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<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<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
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
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<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 the specified tag definition.
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
Delete the specified tag namespace. Only an empty tagnamespace can be deleted. If the tag namespace you are trying to delete is not empty, please remove tag definitions from it first.
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<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<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<GetIdentityProviderResponse> getIdentityProvider(GetIdentityProviderRequest request, AsyncHandler<GetIdentityProviderRequest,GetIdentityProviderResponse> handler)
IdentityAsync
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
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<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<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<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 Identity and Access Management 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<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<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.
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<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<ListIdentityProviderGroupsResponse> listIdentityProviderGroups(ListIdentityProviderGroupsRequest request, AsyncHandler<ListIdentityProviderGroupsRequest,ListIdentityProviderGroupsResponse> handler)
IdentityAsync
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
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.
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
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<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<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<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. - AlthoughuserId
and groupId
are not indvidually 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<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<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
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
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<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 the specified tag definition. You can update description
, and isRetired
.
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. You can update the following field: value
.
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 indvidually after you reactivate the namespace, using updateTag
. For more information about retiring tag namespaces, see Retiring Key Definitions and Namespace Definitions.
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.Copyright © 2016–2019. All rights reserved.