Class IdentityClient
Service client instance for Identity.
Implements
Inherited Members
Namespace: Oci.IdentityService
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class IdentityClient : RegionalClientBase, IDisposable
Constructors
IdentityClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public IdentityClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public IdentityPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
IdentityPaginators |
Waiters
Declaration
public IdentityWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
IdentityWaiters |
Methods
ActivateDomain(ActivateDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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.
<br/>
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.
<br/>
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
the operation's status.
Declaration
public Task<ActivateDomainResponse> ActivateDomain(ActivateDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ActivateDomainRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ActivateDomainResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ActivateDomain API.
ActivateMfaTotpDevice(ActivateMfaTotpDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.
Declaration
public Task<ActivateMfaTotpDeviceResponse> ActivateMfaTotpDevice(ActivateMfaTotpDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ActivateMfaTotpDeviceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ActivateMfaTotpDeviceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ActivateMfaTotpDevice API.
AddTagDefaultLock(AddTagDefaultLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add a resource lock to a tag default.
Declaration
public Task<AddTagDefaultLockResponse> AddTagDefaultLock(AddTagDefaultLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddTagDefaultLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddTagDefaultLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddTagDefaultLock API.
AddTagNamespaceLock(AddTagNamespaceLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add a resource lock to a tag namespace.
Declaration
public Task<AddTagNamespaceLockResponse> AddTagNamespaceLock(AddTagNamespaceLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddTagNamespaceLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddTagNamespaceLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddTagNamespaceLock API.
AddUserToGroup(AddUserToGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds the specified user to the specified group and returns a UserGroupMembership
object with its own OCID.
<br/>
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.
Declaration
public Task<AddUserToGroupResponse> AddUserToGroup(AddUserToGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddUserToGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddUserToGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddUserToGroup API.
AssembleEffectiveTagSet(AssembleEffectiveTagSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<AssembleEffectiveTagSetResponse> AssembleEffectiveTagSet(AssembleEffectiveTagSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AssembleEffectiveTagSetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AssembleEffectiveTagSetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AssembleEffectiveTagSet API.
BulkDeleteResources(BulkDeleteResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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 {@link WorkRequest}. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.
Declaration
public Task<BulkDeleteResourcesResponse> BulkDeleteResources(BulkDeleteResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkDeleteResourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkDeleteResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkDeleteResources API.
BulkDeleteTags(BulkDeleteTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> The following actions happen immediately: <br/>
- 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. <br/> 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. <br/> 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. <br/> After you start this operation, you cannot start either the {@link #deleteTag(DeleteTagRequest) deleteTag} or the {@link #cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest) cascadeDeleteTagNamespace} operation until this process completes. <br/> In order to delete tags, you must first retire the tags. Use {@link #updateTag(UpdateTagRequest) updateTag} to retire a tag.
Declaration
public Task<BulkDeleteTagsResponse> BulkDeleteTags(BulkDeleteTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkDeleteTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkDeleteTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkDeleteTags API.
BulkEditTags(BulkEditTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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: <br/>
- 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.
<br/>
See {@link #bulkEditOperationDetails(BulkEditOperationDetailsRequest) bulkEditOperationDetails} for more information.
<br/>
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 totag set-2
,tag set-1
andtag set-2
cannot have any common tag definitions.
Declaration
public Task<BulkEditTagsResponse> BulkEditTags(BulkEditTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkEditTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkEditTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkEditTags API.
BulkMoveResources(BulkMoveResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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 {@link WorkRequest}. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.
Declaration
public Task<BulkMoveResourcesResponse> BulkMoveResources(BulkMoveResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkMoveResourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkMoveResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkMoveResources API.
CascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> After you start the delete operation: <br/>
- 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. <br/> 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. <br/> 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. <br/> After you start this operation, you cannot start either the {@link #deleteTag(DeleteTagRequest) deleteTag} or the {@link #bulkDeleteTags(BulkDeleteTagsRequest) bulkDeleteTags} operation until this process completes. <br/> To delete a tag namespace, you must first retire it. Use {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace} to retire a tag namespace.
Declaration
public Task<CascadeDeleteTagNamespaceResponse> CascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CascadeDeleteTagNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CascadeDeleteTagNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CascadeDeleteTagNamespace API.
ChangeDomainCompartment(ChangeDomainCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy. <br/> To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.
Declaration
public Task<ChangeDomainCompartmentResponse> ChangeDomainCompartment(ChangeDomainCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDomainCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeDomainCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDomainCompartment API.
ChangeDomainLicenseType(ChangeDomainLicenseTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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 {@link #listAllowedDomainLicenseTypes(ListAllowedDomainLicenseTypesRequest) listAllowedDomainLicenseTypes}.
<br/>
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.
<br/>
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
the operation's status.
Declaration
public Task<ChangeDomainLicenseTypeResponse> ChangeDomainLicenseType(ChangeDomainLicenseTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDomainLicenseTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeDomainLicenseTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDomainLicenseType API.
ChangeTagNamespaceCompartment(ChangeTagNamespaceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the specified tag namespace to the specified compartment within the same tenancy. <br/> 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. <br/> Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
Declaration
public Task<ChangeTagNamespaceCompartmentResponse> ChangeTagNamespaceCompartment(ChangeTagNamespaceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeTagNamespaceCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeTagNamespaceCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeTagNamespaceCompartment API.
CreateAuthToken(CreateAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new auth token for the specified user. For information about what auth tokens are for, see Managing User Credentials. <br/> 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 {@link #updateAuthToken(UpdateAuthTokenRequest) updateAuthToken}. <br/> 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.
Declaration
public Task<CreateAuthTokenResponse> CreateAuthToken(CreateAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAuthTokenRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAuthTokenResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAuthToken API.
CreateCompartment(CreateCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new compartment in the specified compartment.
<br/>
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.
<br/>
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.
<br/>
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
{@link #updateCompartment(UpdateCompartmentRequest) updateCompartment}.
<br/>
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.
Declaration
public Task<CreateCompartmentResponse> CreateCompartment(CreateCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCompartment API.
CreateCustomerSecretKey(CreateCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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 {@link #updateCustomerSecretKey(UpdateCustomerSecretKeyRequest) updateCustomerSecretKey}. <br/> 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.
Declaration
public Task<CreateCustomerSecretKeyResponse> CreateCustomerSecretKey(CreateCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCustomerSecretKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCustomerSecretKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCustomerSecretKey API.
CreateDbCredential(CreateDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new DB credential for the specified user.
Declaration
public Task<CreateDbCredentialResponse> CreateDbCredential(CreateDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDbCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDbCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDbCredential API.
CreateDomain(CreateDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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.
<br/>
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
the operation's status.
<br/>
After creating an identity domain
, first make sure its lifecycleState
changes from CREATING to ACTIVE before you use it.
Declaration
public Task<CreateDomainResponse> CreateDomain(CreateDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDomainRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDomainResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDomain API.
CreateDynamicGroup(CreateDynamicGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new dynamic group in your tenancy.
<br/>
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.
<br/>
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.
<br/>
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 {@link #updateDynamicGroup(UpdateDynamicGroupRequest) updateDynamicGroup}.
<br/>
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.
Declaration
public Task<CreateDynamicGroupResponse> CreateDynamicGroup(CreateDynamicGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDynamicGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDynamicGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDynamicGroup API.
CreateGroup(CreateGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new group in your tenancy.
<br/>
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.
<br/>
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.
<br/>
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 {@link #updateGroup(UpdateGroupRequest) updateGroup}.
<br/>
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.
<br/>
After creating the group, you need to put users in it and write policies for it.
See {@link #addUserToGroup(AddUserToGroupRequest) addUserToGroup} and
{@link #createPolicy(CreatePolicyRequest) createPolicy}.
Declaration
public Task<CreateGroupResponse> CreateGroup(CreateGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateGroup API.
CreateIdentityProvider(CreateIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs.
<br/>
Creates a new identity provider in your tenancy. For more information, see
Identity Providers and Federation.
<br/>
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.
<br/>
You must also specify a name for the IdentityProvider
, which must be unique
across all IdentityProvider
objects in your tenancy and cannot be changed.
<br/>
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
{@link #updateIdentityProvider(UpdateIdentityProviderRequest) updateIdentityProvider}.
<br/>
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.
Declaration
public Task<CreateIdentityProviderResponse> CreateIdentityProvider(CreateIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateIdentityProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateIdentityProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateIdentityProvider API.
CreateIdpGroupMapping(CreateIdpGroupMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Creates a single mapping between an IdP group and an IAM Service {@link Group}.
Declaration
public Task<CreateIdpGroupMappingResponse> CreateIdpGroupMapping(CreateIdpGroupMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateIdpGroupMappingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateIdpGroupMappingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateIdpGroupMapping API.
CreateMfaTotpDevice(CreateMfaTotpDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.
Declaration
public Task<CreateMfaTotpDeviceResponse> CreateMfaTotpDevice(CreateMfaTotpDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateMfaTotpDeviceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateMfaTotpDeviceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateMfaTotpDevice API.
CreateNetworkSource(CreateNetworkSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new network source in your tenancy.
<br/>
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.
<br/>
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.
<br/>
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 {@link #updateNetworkSource(UpdateNetworkSourceRequest) updateNetworkSource}.
<br/>
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.
<br/>
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.
Declaration
public Task<CreateNetworkSourceResponse> CreateNetworkSource(CreateNetworkSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateNetworkSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateNetworkSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateNetworkSource API.
CreateOAuthClientCredential(CreateOAuthClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates Oauth token for the user
Declaration
public Task<CreateOAuthClientCredentialResponse> CreateOAuthClientCredential(CreateOAuthClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOAuthClientCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOAuthClientCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOAuthClientCredential API.
CreateOrResetUIPassword(CreateOrResetUIPasswordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Console one-time password for the specified user. For more information about user credentials, see User Credentials. <br/> 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. <br/> (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. <br/> Note: The user's Console login is the unique name you specified when you created the user (see {@link #createUser(CreateUserRequest) createUser}).
Declaration
public Task<CreateOrResetUIPasswordResponse> CreateOrResetUIPassword(CreateOrResetUIPasswordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOrResetUIPasswordRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOrResetUIPasswordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOrResetUIPassword API.
CreatePolicy(CreatePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
<br/>
You must specify a name for the policy, which must be unique across all policies in your tenancy
and cannot be changed.
<br/>
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 {@link #updatePolicy(UpdatePolicyRequest) updatePolicy}.
<br/>
You must specify one or more policy statements in the statements array. For information about writing
policies, see How Policies Work and
Common Policies.
<br/>
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.
<br/>
New policies take effect typically within 10 seconds.
Declaration
public Task<CreatePolicyResponse> CreatePolicy(CreatePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePolicy API.
CreateRegionSubscription(CreateRegionSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a subscription to a region for a tenancy.
Declaration
public Task<CreateRegionSubscriptionResponse> CreateRegionSubscription(CreateRegionSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRegionSubscriptionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRegionSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRegionSubscription API.
CreateSmtpCredential(CreateSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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 {@link #updateSmtpCredential(UpdateSmtpCredentialRequest) updateSmtpCredential}.
Declaration
public Task<CreateSmtpCredentialResponse> CreateSmtpCredential(CreateSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSmtpCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSmtpCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSmtpCredential API.
CreateSwiftPassword(CreateSwiftPasswordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. Use {@link #createAuthToken(CreateAuthTokenRequest) createAuthToken} instead. <br/> Creates a new Swift password for the specified user. For information about what Swift passwords are for, see Managing User Credentials. <br/> 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 {@link #updateSwiftPassword(UpdateSwiftPasswordRequest) updateSwiftPassword}. <br/> 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.
Declaration
public Task<CreateSwiftPasswordResponse> CreateSwiftPassword(CreateSwiftPasswordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSwiftPasswordRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSwiftPasswordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSwiftPassword API.
CreateTag(CreateTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new tag in the specified tag namespace. <br/> The tag requires either the OCID or the name of the tag namespace that will contain this tag definition. <br/> 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. <br/> The tag must have a description. It does not have to be unique, and you can change it with {@link #updateTag(UpdateTagRequest) updateTag}. <br/> 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. <br/>
- 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 {@link #enumTagDefinitionValidator(EnumTagDefinitionValidatorRequest) enumTagDefinitionValidator}.
Declaration
public Task<CreateTagResponse> CreateTag(CreateTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTag API.
CreateTagDefault(CreateTagDefaultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new tag default in the specified compartment for the specified tag definition. <br/> 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. <br/>
- 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.
Declaration
public Task<CreateTagDefaultResponse> CreateTagDefault(CreateTagDefaultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTagDefaultRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTagDefaultResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTagDefault API.
CreateTagNamespace(CreateTagNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new tag namespace in the specified compartment. <br/> You must specify the compartment ID in the request object (remember that the tenancy is simply the root compartment). <br/> 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. <br/> You must also specify a description for the namespace. It does not have to be unique, and you can change it with {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}.
Declaration
public Task<CreateTagNamespaceResponse> CreateTagNamespace(CreateTagNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTagNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTagNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTagNamespace API.
CreateUser(CreateUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other
IAM Service components, see Overview of IAM.
<br/>
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.
<br/>
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.
<br/>
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
{@link #updateUser(UpdateUserRequest) 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.
<br/>
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.
<br/>
A new user has no permissions until you place the user in one or more groups (see
{@link #addUserToGroup(AddUserToGroupRequest) addUserToGroup}). If the user needs to
access the Console, you need to provide the user a password (see
{@link #createOrResetUIPassword(CreateOrResetUIPasswordRequest) 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
{@link #uploadApiKey(UploadApiKeyRequest) uploadApiKey}).
<br/>
Important: Make sure to inform the new user which compartment(s) they have access to.
Declaration
public Task<CreateUserResponse> CreateUser(CreateUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateUser API.
DeactivateDomain(DeactivateDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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.
<br/>
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.
<br/>
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
the operation's status.
Declaration
public Task<DeactivateDomainResponse> DeactivateDomain(DeactivateDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeactivateDomainRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeactivateDomainResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeactivateDomain API.
DeleteApiKey(DeleteApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified API signing key for the specified user. <br/> 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.
Declaration
public Task<DeleteApiKeyResponse> DeleteApiKey(DeleteApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteApiKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteApiKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteApiKey API.
DeleteAuthToken(DeleteAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified auth token for the specified user.
Declaration
public Task<DeleteAuthTokenResponse> DeleteAuthToken(DeleteAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAuthTokenRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAuthTokenResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAuthToken API.
DeleteCompartment(DeleteCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified compartment. The compartment must be empty.
Declaration
public Task<DeleteCompartmentResponse> DeleteCompartment(DeleteCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCompartment API.
DeleteCustomerSecretKey(DeleteCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified secret key for the specified user.
Declaration
public Task<DeleteCustomerSecretKeyResponse> DeleteCustomerSecretKey(DeleteCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCustomerSecretKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCustomerSecretKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCustomerSecretKey API.
DeleteDbCredential(DeleteDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified DB credential for the specified user.
Declaration
public Task<DeleteDbCredentialResponse> DeleteDbCredential(DeleteDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDbCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDbCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDbCredential API.
DeleteDomain(DeleteDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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.
Declaration
public Task<DeleteDomainResponse> DeleteDomain(DeleteDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDomainRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDomainResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDomain API.
DeleteDynamicGroup(DeleteDynamicGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified dynamic group.
Declaration
public Task<DeleteDynamicGroupResponse> DeleteDynamicGroup(DeleteDynamicGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDynamicGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDynamicGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDynamicGroup API.
DeleteGroup(DeleteGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified group. The group must be empty.
Declaration
public Task<DeleteGroupResponse> DeleteGroup(DeleteGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteGroup API.
DeleteIdentityProvider(DeleteIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Deletes the specified identity provider. The identity provider must not have any group mappings (see {@link IdpGroupMapping}).
Declaration
public Task<DeleteIdentityProviderResponse> DeleteIdentityProvider(DeleteIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteIdentityProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteIdentityProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteIdentityProvider API.
DeleteIdpGroupMapping(DeleteIdpGroupMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Deletes the specified group mapping.
Declaration
public Task<DeleteIdpGroupMappingResponse> DeleteIdpGroupMapping(DeleteIdpGroupMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteIdpGroupMappingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteIdpGroupMappingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteIdpGroupMapping API.
DeleteMfaTotpDevice(DeleteMfaTotpDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified MFA TOTP device for the specified user.
Declaration
public Task<DeleteMfaTotpDeviceResponse> DeleteMfaTotpDevice(DeleteMfaTotpDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteMfaTotpDeviceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteMfaTotpDeviceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteMfaTotpDevice API.
DeleteNetworkSource(DeleteNetworkSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified network source.
Declaration
public Task<DeleteNetworkSourceResponse> DeleteNetworkSource(DeleteNetworkSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteNetworkSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteNetworkSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteNetworkSource API.
DeleteOAuthClientCredential(DeleteOAuthClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete Oauth token for the user
Declaration
public Task<DeleteOAuthClientCredentialResponse> DeleteOAuthClientCredential(DeleteOAuthClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOAuthClientCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOAuthClientCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOAuthClientCredential API.
DeletePolicy(DeletePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified policy. The deletion takes effect typically within 10 seconds.
Declaration
public Task<DeletePolicyResponse> DeletePolicy(DeletePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePolicy API.
DeleteSmtpCredential(DeleteSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified SMTP credential for the specified user.
Declaration
public Task<DeleteSmtpCredentialResponse> DeleteSmtpCredential(DeleteSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSmtpCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSmtpCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSmtpCredential API.
DeleteSwiftPassword(DeleteSwiftPasswordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. Use {@link #deleteAuthToken(DeleteAuthTokenRequest) deleteAuthToken} instead. <br/> Deletes the specified Swift password for the specified user.
Declaration
public Task<DeleteSwiftPasswordResponse> DeleteSwiftPassword(DeleteSwiftPasswordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSwiftPasswordRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSwiftPasswordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSwiftPassword API.
DeleteTag(DeleteTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified tag definition. This operation triggers a process that removes the tag from all resources in your tenancy. <br/> 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. <br/> 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. <br/> 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. <br/> After you start this operation, you cannot start either the {@link #bulkDeleteTags(BulkDeleteTagsRequest) bulkDeleteTags} or the {@link #cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest) cascadeDeleteTagNamespace} operation until this process completes. <br/> To delete a tag, you must first retire it. Use {@link #updateTag(UpdateTagRequest) updateTag} to retire a tag.
Declaration
public Task<DeleteTagResponse> DeleteTag(DeleteTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTag API.
DeleteTagDefault(DeleteTagDefaultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the the specified tag default.
Declaration
public Task<DeleteTagDefaultResponse> DeleteTagDefault(DeleteTagDefaultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTagDefaultRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTagDefaultResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTagDefault API.
DeleteTagNamespace(DeleteTagNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> Use {@link #cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest) cascadeDeleteTagNamespace} to delete a tag namespace along with all of the tag definitions contained within that namespace. <br/> Use {@link #deleteTag(DeleteTagRequest) deleteTag} to delete a tag definition.
Declaration
public Task<DeleteTagNamespaceResponse> DeleteTagNamespace(DeleteTagNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTagNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTagNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTagNamespace API.
DeleteUser(DeleteUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified user. The user must not be in any groups.
Declaration
public Task<DeleteUserResponse> DeleteUser(DeleteUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteUser API.
EnableReplicationToRegion(EnableReplicationToRegionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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.
<br/>
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.
<br/>
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves
the operation's status.
Declaration
public Task<EnableReplicationToRegionResponse> EnableReplicationToRegion(EnableReplicationToRegionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableReplicationToRegionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableReplicationToRegionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableReplicationToRegion API.
GenerateTotpSeed(GenerateTotpSeedRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Generate seed for the MFA TOTP device.
Declaration
public Task<GenerateTotpSeedResponse> GenerateTotpSeed(GenerateTotpSeedRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GenerateTotpSeedRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GenerateTotpSeedResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateTotpSeed API.
GetAuthenticationPolicy(GetAuthenticationPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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).
Declaration
public Task<GetAuthenticationPolicyResponse> GetAuthenticationPolicy(GetAuthenticationPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAuthenticationPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAuthenticationPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAuthenticationPolicy API.
GetCompartment(GetCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified compartment's information. <br/> 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 {@link #listInstances(ListInstancesRequest) listInstances} operation in the Cloud Compute Service or the {@link #listVolumes(ListVolumesRequest) listVolumes} operation in Cloud Block Storage.
Declaration
public Task<GetCompartmentResponse> GetCompartment(GetCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCompartment API.
GetDomain(GetDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(For tenancies that support identity domains) Gets the specified identity domain's information.
Declaration
public Task<GetDomainResponse> GetDomain(GetDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDomainRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDomainResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDomain API.
GetDynamicGroup(GetDynamicGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified dynamic group's information.
Declaration
public Task<GetDynamicGroupResponse> GetDynamicGroup(GetDynamicGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDynamicGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDynamicGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDynamicGroup API.
GetGroup(GetGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified group's information. <br/> This operation does not return a list of all the users in the group. To do that, use {@link #listUserGroupMemberships(ListUserGroupMembershipsRequest) listUserGroupMemberships} and provide the group's OCID as a query parameter in the request.
Declaration
public Task<GetGroupResponse> GetGroup(GetGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetGroup API.
GetIamWorkRequest(GetIamWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<GetIamWorkRequestResponse> GetIamWorkRequest(GetIamWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIamWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIamWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIamWorkRequest API.
GetIdentityProvider(GetIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Gets the specified identity provider's information.
Declaration
public Task<GetIdentityProviderResponse> GetIdentityProvider(GetIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIdentityProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIdentityProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIdentityProvider API.
GetIdpGroupMapping(GetIdpGroupMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Gets the specified group mapping.
Declaration
public Task<GetIdpGroupMappingResponse> GetIdpGroupMapping(GetIdpGroupMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIdpGroupMappingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIdpGroupMappingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIdpGroupMapping API.
GetMfaTotpDevice(GetMfaTotpDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified MFA TOTP device for the specified user.
Declaration
public Task<GetMfaTotpDeviceResponse> GetMfaTotpDevice(GetMfaTotpDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetMfaTotpDeviceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetMfaTotpDeviceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetMfaTotpDevice API.
GetNetworkSource(GetNetworkSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified network source's information.
Declaration
public Task<GetNetworkSourceResponse> GetNetworkSource(GetNetworkSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNetworkSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNetworkSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNetworkSource API.
GetPolicy(GetPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified policy's information.
Declaration
public Task<GetPolicyResponse> GetPolicy(GetPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPolicy API.
GetStandardTagTemplate(GetStandardTagTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the standard tag namespace template given the standard tag namespace name.
Declaration
public Task<GetStandardTagTemplateResponse> GetStandardTagTemplate(GetStandardTagTemplateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetStandardTagTemplateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetStandardTagTemplateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetStandardTagTemplate API.
GetTag(GetTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified tag's information.
Declaration
public Task<GetTagResponse> GetTag(GetTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTag API.
GetTagDefault(GetTagDefaultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the specified tag default.
Declaration
public Task<GetTagDefaultResponse> GetTagDefault(GetTagDefaultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTagDefaultRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTagDefaultResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTagDefault API.
GetTagNamespace(GetTagNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified tag namespace's information.
Declaration
public Task<GetTagNamespaceResponse> GetTagNamespace(GetTagNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTagNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTagNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTagNamespace API.
GetTaggingWorkRequest(GetTaggingWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in tagging service.
Declaration
public Task<GetTaggingWorkRequestResponse> GetTaggingWorkRequest(GetTaggingWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTaggingWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTaggingWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTaggingWorkRequest API.
GetTenancy(GetTenancyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified tenancy's information.
Declaration
public Task<GetTenancyResponse> GetTenancy(GetTenancyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTenancyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTenancyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTenancy API.
GetUser(GetUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified user's information.
Declaration
public Task<GetUserResponse> GetUser(GetUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetUser API.
GetUserGroupMembership(GetUserGroupMembershipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified UserGroupMembership's information.
Declaration
public Task<GetUserGroupMembershipResponse> GetUserGroupMembership(GetUserGroupMembershipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetUserGroupMembershipRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetUserGroupMembershipResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetUserGroupMembership API.
GetUserUIPasswordInformation(GetUserUIPasswordInformationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<GetUserUIPasswordInformationResponse> GetUserUIPasswordInformation(GetUserUIPasswordInformationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetUserUIPasswordInformationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetUserUIPasswordInformationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetUserUIPasswordInformation API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ImportStandardTags(ImportStandardTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ImportStandardTagsResponse> ImportStandardTags(ImportStandardTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportStandardTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportStandardTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportStandardTags API.
ListAllowedDomainLicenseTypes(ListAllowedDomainLicenseTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(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.)
<br/>
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.
Declaration
public Task<ListAllowedDomainLicenseTypesResponse> ListAllowedDomainLicenseTypes(ListAllowedDomainLicenseTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAllowedDomainLicenseTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAllowedDomainLicenseTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAllowedDomainLicenseTypes API.
ListApiKeys(ListApiKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the API signing keys for the specified user. A user can have a maximum of three keys. <br/> 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.
Declaration
public Task<ListApiKeysResponse> ListApiKeys(ListApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListApiKeysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListApiKeysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListApiKeys API.
ListAuthTokens(ListAuthTokensRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListAuthTokensResponse> ListAuthTokens(ListAuthTokensRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAuthTokensRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAuthTokensResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAuthTokens API.
ListAvailabilityDomains(ListAvailabilityDomainsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListAvailabilityDomainsResponse> ListAvailabilityDomains(ListAvailabilityDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAvailabilityDomainsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAvailabilityDomainsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAvailabilityDomains API.
ListBulkActionResourceTypes(ListBulkActionResourceTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct resource-type information to the {@link #bulkDeleteResources(BulkDeleteResourcesRequest) bulkDeleteResources} and {@link #bulkMoveResources(BulkMoveResourcesRequest) 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.
Declaration
public Task<ListBulkActionResourceTypesResponse> ListBulkActionResourceTypes(ListBulkActionResourceTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBulkActionResourceTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListBulkActionResourceTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBulkActionResourceTypes API.
ListBulkEditTagsResourceTypes(ListBulkEditTagsResourceTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the resource types that support bulk tag editing.
Declaration
public Task<ListBulkEditTagsResourceTypesResponse> ListBulkEditTagsResourceTypes(ListBulkEditTagsResourceTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBulkEditTagsResourceTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListBulkEditTagsResourceTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBulkEditTagsResourceTypes API.
ListCompartments(ListCompartmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the compartments in a specified compartment. The members of the list
returned depends on the values set for several parameters.
<br/>
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).
<br/>
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).
<br/>
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.
<br/>
See Where to Get the Tenancy's OCID and User's OCID.
Declaration
public Task<ListCompartmentsResponse> ListCompartments(ListCompartmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCompartmentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCompartmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCompartments API.
ListCostTrackingTags(ListCostTrackingTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all the tags enabled for cost-tracking in the specified tenancy. For information about cost-tracking tags, see Using Cost-tracking Tags.
Declaration
public Task<ListCostTrackingTagsResponse> ListCostTrackingTags(ListCostTrackingTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCostTrackingTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCostTrackingTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCostTrackingTags API.
ListCustomerSecretKeys(ListCustomerSecretKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListCustomerSecretKeysResponse> ListCustomerSecretKeys(ListCustomerSecretKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCustomerSecretKeysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCustomerSecretKeysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCustomerSecretKeys API.
ListDbCredentials(ListDbCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the DB credentials for the specified user. The returned object contains the credential's OCID
Declaration
public Task<ListDbCredentialsResponse> ListDbCredentials(ListDbCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDbCredentialsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDbCredentialsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDbCredentials API.
ListDomains(ListDomainsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(For tenancies that support identity domains) Lists all identity domains within a tenancy.
Declaration
public Task<ListDomainsResponse> ListDomains(ListDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDomainsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDomainsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDomains API.
ListDynamicGroups(ListDynamicGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListDynamicGroupsResponse> ListDynamicGroups(ListDynamicGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDynamicGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDynamicGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDynamicGroups API.
ListFaultDomains(ListFaultDomainsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListFaultDomainsResponse> ListFaultDomains(ListFaultDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListFaultDomainsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListFaultDomainsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListFaultDomains API.
ListGroups(ListGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListGroupsResponse> ListGroups(ListGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListGroups API.
ListIamWorkRequestErrors(ListIamWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListIamWorkRequestErrorsResponse> ListIamWorkRequestErrors(ListIamWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIamWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIamWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIamWorkRequestErrors API.
ListIamWorkRequestLogs(ListIamWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListIamWorkRequestLogsResponse> ListIamWorkRequestLogs(ListIamWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIamWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIamWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIamWorkRequestLogs API.
ListIamWorkRequests(ListIamWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListIamWorkRequestsResponse> ListIamWorkRequests(ListIamWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIamWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIamWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIamWorkRequests API.
ListIdentityProviderGroups(ListIdentityProviderGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Lists the identity provider groups.
Declaration
public Task<ListIdentityProviderGroupsResponse> ListIdentityProviderGroups(ListIdentityProviderGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIdentityProviderGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIdentityProviderGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIdentityProviderGroups API.
ListIdentityProviders(ListIdentityProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs.
<br/>
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.
Declaration
public Task<ListIdentityProvidersResponse> ListIdentityProviders(ListIdentityProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIdentityProvidersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIdentityProvidersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIdentityProviders API.
ListIdpGroupMappings(ListIdpGroupMappingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Lists the group mappings for the specified identity provider.
Declaration
public Task<ListIdpGroupMappingsResponse> ListIdpGroupMappings(ListIdpGroupMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIdpGroupMappingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIdpGroupMappingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIdpGroupMappings API.
ListMfaTotpDevices(ListMfaTotpDevicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListMfaTotpDevicesResponse> ListMfaTotpDevices(ListMfaTotpDevicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMfaTotpDevicesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListMfaTotpDevicesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMfaTotpDevices API.
ListNetworkSources(ListNetworkSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListNetworkSourcesResponse> ListNetworkSources(ListNetworkSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNetworkSourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNetworkSourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNetworkSources API.
ListOAuthClientCredentials(ListOAuthClientCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List of Oauth tokens for the user
Declaration
public Task<ListOAuthClientCredentialsResponse> ListOAuthClientCredentials(ListOAuthClientCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOAuthClientCredentialsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOAuthClientCredentialsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOAuthClientCredentials API.
ListPolicies(ListPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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.
Declaration
public Task<ListPoliciesResponse> ListPolicies(ListPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPoliciesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPoliciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPolicies API.
ListRegionSubscriptions(ListRegionSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the region subscriptions for the specified tenancy.
Declaration
public Task<ListRegionSubscriptionsResponse> ListRegionSubscriptions(ListRegionSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRegionSubscriptionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRegionSubscriptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRegionSubscriptions API.
ListRegions(ListRegionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all the regions offered by Oracle Cloud Infrastructure.
Declaration
public Task<ListRegionsResponse> ListRegions(ListRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRegionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRegionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRegions API.
ListSmtpCredentials(ListSmtpCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListSmtpCredentialsResponse> ListSmtpCredentials(ListSmtpCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSmtpCredentialsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSmtpCredentialsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSmtpCredentials API.
ListStandardTagNamespaces(ListStandardTagNamespacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists available standard tag namespaces that users can create.
Declaration
public Task<ListStandardTagNamespacesResponse> ListStandardTagNamespaces(ListStandardTagNamespacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListStandardTagNamespacesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListStandardTagNamespacesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListStandardTagNamespaces API.
ListSwiftPasswords(ListSwiftPasswordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. Use {@link #listAuthTokens(ListAuthTokensRequest) listAuthTokens} instead. <br/> 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.
Declaration
public Task<ListSwiftPasswordsResponse> ListSwiftPasswords(ListSwiftPasswordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSwiftPasswordsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSwiftPasswordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSwiftPasswords API.
ListTagDefaults(ListTagDefaultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tag defaults for tag definitions in the specified compartment.
Declaration
public Task<ListTagDefaultsResponse> ListTagDefaults(ListTagDefaultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTagDefaultsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTagDefaultsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTagDefaults API.
ListTagNamespaces(ListTagNamespacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tag namespaces in the specified compartment.
Declaration
public Task<ListTagNamespacesResponse> ListTagNamespaces(ListTagNamespacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTagNamespacesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTagNamespacesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTagNamespaces API.
ListTaggingWorkRequestErrors(ListTaggingWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the errors for a work request.
Declaration
public Task<ListTaggingWorkRequestErrorsResponse> ListTaggingWorkRequestErrors(ListTaggingWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTaggingWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTaggingWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTaggingWorkRequestErrors API.
ListTaggingWorkRequestLogs(ListTaggingWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the logs for a work request.
Declaration
public Task<ListTaggingWorkRequestLogsResponse> ListTaggingWorkRequestLogs(ListTaggingWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTaggingWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTaggingWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTaggingWorkRequestLogs API.
ListTaggingWorkRequests(ListTaggingWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tagging work requests in compartment.
Declaration
public Task<ListTaggingWorkRequestsResponse> ListTaggingWorkRequests(ListTaggingWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTaggingWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTaggingWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTaggingWorkRequests API.
ListTags(ListTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tag definitions in the specified tag namespace.
Declaration
public Task<ListTagsResponse> ListTags(ListTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTags API.
ListUserGroupMemberships(ListUserGroupMembershipsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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:
<br/>
- 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
andgroupId
to determine if the specified user is in the specified group. If the answer is no, the response is an empty list. - Although
userId
andgroupId
are not individually required, you must set one of them.
Declaration
public Task<ListUserGroupMembershipsResponse> ListUserGroupMemberships(ListUserGroupMembershipsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListUserGroupMembershipsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListUserGroupMembershipsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListUserGroupMemberships API.
ListUsers(ListUsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListUsersResponse> ListUsers(ListUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListUsersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListUsersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListUsers API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
MoveCompartment(MoveCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
<br/>
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.
Declaration
public Task<MoveCompartmentResponse> MoveCompartment(MoveCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
MoveCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<MoveCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use MoveCompartment API.
RecoverCompartment(RecoverCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Recover the compartment from DELETED state to ACTIVE state.
Declaration
public Task<RecoverCompartmentResponse> RecoverCompartment(RecoverCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RecoverCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RecoverCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RecoverCompartment API.
RemoveTagDefaultLock(RemoveTagDefaultLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove a resource lock from a tag default.
Declaration
public Task<RemoveTagDefaultLockResponse> RemoveTagDefaultLock(RemoveTagDefaultLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveTagDefaultLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveTagDefaultLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveTagDefaultLock API.
RemoveTagNamespaceLock(RemoveTagNamespaceLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove a resource lock from a tag namespace.
Declaration
public Task<RemoveTagNamespaceLockResponse> RemoveTagNamespaceLock(RemoveTagNamespaceLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveTagNamespaceLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveTagNamespaceLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveTagNamespaceLock API.
RemoveUserFromGroup(RemoveUserFromGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a user from a group by deleting the corresponding UserGroupMembership
.
Declaration
public Task<RemoveUserFromGroupResponse> RemoveUserFromGroup(RemoveUserFromGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveUserFromGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveUserFromGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveUserFromGroup API.
ResetIdpScimClient(ResetIdpScimClientRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
Declaration
public Task<ResetIdpScimClientResponse> ResetIdpScimClient(ResetIdpScimClientRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ResetIdpScimClientRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ResetIdpScimClientResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ResetIdpScimClient API.
UpdateAuthToken(UpdateAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified auth token's description.
Declaration
public Task<UpdateAuthTokenResponse> UpdateAuthToken(UpdateAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAuthTokenRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAuthTokenResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAuthToken API.
UpdateAuthenticationPolicy(UpdateAuthenticationPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates authentication policy for the specified tenancy.
Declaration
public Task<UpdateAuthenticationPolicyResponse> UpdateAuthenticationPolicy(UpdateAuthenticationPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAuthenticationPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAuthenticationPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAuthenticationPolicy API.
UpdateCompartment(UpdateCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified compartment's description or name. You can't update the root compartment.
Declaration
public Task<UpdateCompartmentResponse> UpdateCompartment(UpdateCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCompartment API.
UpdateCustomerSecretKey(UpdateCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified secret key's description.
Declaration
public Task<UpdateCustomerSecretKeyResponse> UpdateCustomerSecretKey(UpdateCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCustomerSecretKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCustomerSecretKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCustomerSecretKey API.
UpdateDomain(UpdateDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
(For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe. <br/> To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.
Declaration
public Task<UpdateDomainResponse> UpdateDomain(UpdateDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDomainRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDomainResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDomain API.
UpdateDynamicGroup(UpdateDynamicGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified dynamic group.
Declaration
public Task<UpdateDynamicGroupResponse> UpdateDynamicGroup(UpdateDynamicGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDynamicGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDynamicGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDynamicGroup API.
UpdateGroup(UpdateGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified group.
Declaration
public Task<UpdateGroupResponse> UpdateGroup(UpdateGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateGroup API.
UpdateIdentityProvider(UpdateIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Updates the specified identity provider.
Declaration
public Task<UpdateIdentityProviderResponse> UpdateIdentityProvider(UpdateIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIdentityProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIdentityProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIdentityProvider API.
UpdateIdpGroupMapping(UpdateIdpGroupMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. For more information, see Deprecated IAM Service APIs. <br/> Updates the specified group mapping.
Declaration
public Task<UpdateIdpGroupMappingResponse> UpdateIdpGroupMapping(UpdateIdpGroupMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIdpGroupMappingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIdpGroupMappingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIdpGroupMapping API.
UpdateNetworkSource(UpdateNetworkSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified network source.
Declaration
public Task<UpdateNetworkSourceResponse> UpdateNetworkSource(UpdateNetworkSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNetworkSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNetworkSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNetworkSource API.
UpdateOAuthClientCredential(UpdateOAuthClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates Oauth token for the user
Declaration
public Task<UpdateOAuthClientCredentialResponse> UpdateOAuthClientCredential(UpdateOAuthClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOAuthClientCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOAuthClientCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOAuthClientCredential API.
UpdatePolicy(UpdatePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified policy. You can update the description or the policy statements themselves. <br/> Policy changes take effect typically within 10 seconds.
Declaration
public Task<UpdatePolicyResponse> UpdatePolicy(UpdatePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePolicy API.
UpdateSmtpCredential(UpdateSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified SMTP credential's description.
Declaration
public Task<UpdateSmtpCredentialResponse> UpdateSmtpCredential(UpdateSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSmtpCredentialRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSmtpCredentialResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSmtpCredential API.
UpdateSwiftPassword(UpdateSwiftPasswordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deprecated. Use {@link #updateAuthToken(UpdateAuthTokenRequest) updateAuthToken} instead. <br/> Updates the specified Swift password's description.
Declaration
public Task<UpdateSwiftPasswordResponse> UpdateSwiftPassword(UpdateSwiftPasswordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSwiftPasswordRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSwiftPasswordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSwiftPassword API.
UpdateTag(UpdateTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified tag definition.
<br/>
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.
<br/>
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.
Declaration
public Task<UpdateTagResponse> UpdateTag(UpdateTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTag API.
UpdateTagDefault(UpdateTagDefaultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/>
- 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.
Declaration
public Task<UpdateTagDefaultResponse> UpdateTagDefault(UpdateTagDefaultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTagDefaultRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTagDefaultResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTagDefault API.
UpdateTagNamespace(UpdateTagNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the the specified tag namespace. You can't update the namespace name.
<br/>
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 {@link #updateTag(UpdateTagRequest) updateTag}. For more information about retiring tag namespaces, see
Retiring Key Definitions and Namespace Definitions.
<br/>
You can't add a namespace with the same name as a retired namespace in the same tenancy.
Declaration
public Task<UpdateTagNamespaceResponse> UpdateTagNamespace(UpdateTagNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTagNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTagNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTagNamespace API.
UpdateUser(UpdateUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the description of the specified user.
Declaration
public Task<UpdateUserResponse> UpdateUser(UpdateUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateUserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateUserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateUser API.
UpdateUserCapabilities(UpdateUserCapabilitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the capabilities of the specified user.
Declaration
public Task<UpdateUserCapabilitiesResponse> UpdateUserCapabilities(UpdateUserCapabilitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateUserCapabilitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateUserCapabilitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateUserCapabilities API.
UpdateUserState(UpdateUserStateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the state of the specified user.
Declaration
public Task<UpdateUserStateResponse> UpdateUserState(UpdateUserStateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateUserStateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateUserStateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateUserState API.
UploadApiKey(UploadApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Uploads an API signing key for the specified user.
<br/>
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.
<br/>
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.
<br/>
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.
Declaration
public Task<UploadApiKeyResponse> UploadApiKey(UploadApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadApiKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadApiKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadApiKey API.