Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IdentityClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • IdentityClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new IdentityClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): IdentityClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: IdentityWaiter

targetService

targetService: string = "Identity"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://identity.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

activateDomain

  • (For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ActivateDomain API.

    Parameters

    Returns Promise<ActivateDomainResponse>

    ActivateDomainResponse

activateMfaTotpDevice

  • Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ActivateMfaTotpDevice API.

    Parameters

    Returns Promise<ActivateMfaTotpDeviceResponse>

    ActivateMfaTotpDeviceResponse

addTagDefaultLock

  • Add a resource lock to a tag default.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddTagDefaultLock API.

    Parameters

    Returns Promise<AddTagDefaultLockResponse>

    AddTagDefaultLockResponse

addTagNamespaceLock

  • Add a resource lock to a tag namespace.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddTagNamespaceLock API.

    Parameters

    Returns Promise<AddTagNamespaceLockResponse>

    AddTagNamespaceLockResponse

addUserToGroup

  • Adds the specified user to the specified group and returns a UserGroupMembership object with its own OCID.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddUserToGroup API.

    Parameters

    Returns Promise<AddUserToGroupResponse>

    AddUserToGroupResponse

assembleEffectiveTagSet

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AssembleEffectiveTagSet API.

    Parameters

    Returns Promise<AssembleEffectiveTagSetResponse>

    AssembleEffectiveTagSetResponse

bulkDeleteResources

  • Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate permissions to delete the resources in the request. This API can only be invoked from the tenancy's home region. This operation creates a WorkRequest. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkDeleteResources API.

    Parameters

    Returns Promise<BulkDeleteResourcesResponse>

    BulkDeleteResourcesResponse

bulkDeleteTags

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

    The following actions happen immediately:

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

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

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

    After you start this operation, you cannot start either the {@link #deleteTag(DeleteTagRequest) deleteTag} or the {@link #cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest) cascadeDeleteTagNamespace} operation until this process completes.

    In order to delete tags, you must first retire the tags. Use {@link #updateTag(UpdateTagRequest) updateTag} to retire a tag.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkDeleteTags API.

    Parameters

    Returns Promise<BulkDeleteTagsResponse>

    BulkDeleteTagsResponse

bulkEditTags

  • Edits the specified list of tag key definitions for the selected resources. This operation triggers a process that edits the tags on all selected resources. The possible actions are:

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

    See {@link #bulkEditOperationDetails(BulkEditOperationDetailsRequest) bulkEditOperationDetails} for more information.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkEditTags API.

    Parameters

    Returns Promise<BulkEditTagsResponse>

    BulkEditTagsResponse

bulkMoveResources

  • Moves multiple resources from one compartment to another. All resources must be in the same compartment. This API can only be invoked from the tenancy's home region. To move resources, you must have the appropriate permissions to move the resource in both the source and target compartments. This operation creates a WorkRequest. Use the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API to monitor the status of the bulk action.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkMoveResources API.

    Parameters

    Returns Promise<BulkMoveResourcesResponse>

    BulkMoveResourcesResponse

cascadeDeleteTagNamespace

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

    After you start the delete operation:

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

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

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

    After you start this operation, you cannot start either the {@link #deleteTag(DeleteTagRequest) deleteTag} or the {@link #bulkDeleteTags(BulkDeleteTagsRequest) bulkDeleteTags} operation until this process completes.

    To delete a tag namespace, you must first retire it. Use {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace} to retire a tag namespace.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CascadeDeleteTagNamespace API.

    Parameters

    Returns Promise<CascadeDeleteTagNamespaceResponse>

    CascadeDeleteTagNamespaceResponse

changeDomainCompartment

  • (For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDomainCompartment API.

    Parameters

    Returns Promise<ChangeDomainCompartmentResponse>

    ChangeDomainCompartmentResponse

changeDomainLicenseType

  • (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}.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDomainLicenseType API.

    Parameters

    Returns Promise<ChangeDomainLicenseTypeResponse>

    ChangeDomainLicenseTypeResponse

changeTagNamespaceCompartment

  • Moves the specified tag namespace to the specified compartment within the same tenancy.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeTagNamespaceCompartment API.

    Parameters

    Returns Promise<ChangeTagNamespaceCompartmentResponse>

    ChangeTagNamespaceCompartmentResponse

close

  • close(): void

createAuthToken

  • Creates a new auth token for the specified user. For information about what auth tokens are for, see Managing User Credentials.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAuthToken API.

    Parameters

    Returns Promise<CreateAuthTokenResponse>

    CreateAuthTokenResponse

createCompartment

  • Creates a new compartment in the specified compartment.

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

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCompartment API.

    Parameters

    Returns Promise<CreateCompartmentResponse>

    CreateCompartmentResponse

createCustomerSecretKey

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCustomerSecretKey API.

    Parameters

    Returns Promise<CreateCustomerSecretKeyResponse>

    CreateCustomerSecretKeyResponse

createDbCredential

  • Creates a new DB credential for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDbCredential API.

    Parameters

    Returns Promise<CreateDbCredentialResponse>

    CreateDbCredentialResponse

createDomain

  • (For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in homeRegion. After you send your request, the temporary lifecycleState of this identity domain is set to CREATING and lifecycleDetails to UPDATING. When creation of the identity domain completes, this identity domain's lifecycleState is set to ACTIVE and lifecycleDetails to null.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDomain API.

    Parameters

    Returns Promise<CreateDomainResponse>

    CreateDomainResponse

createDynamicGroup

  • Creates a new dynamic group in your tenancy.

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

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDynamicGroup API.

    Parameters

    Returns Promise<CreateDynamicGroupResponse>

    CreateDynamicGroupResponse

createGroup

  • Creates a new group in your tenancy.

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

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

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

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

    After creating the group, you need to put users in it and write policies for it. See {@link #addUserToGroup(AddUserToGroupRequest) addUserToGroup} and {@link #createPolicy(CreatePolicyRequest) createPolicy}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateGroup API.

    Parameters

    Returns Promise<CreateGroupResponse>

    CreateGroupResponse

createIdentityProvider

  • Deprecated. For more information, see Deprecated IAM Service APIs.

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

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

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateIdentityProvider API.

    Parameters

    Returns Promise<CreateIdentityProviderResponse>

    CreateIdentityProviderResponse

createIdpGroupMapping

createMfaTotpDevice

  • Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMfaTotpDevice API.

    Parameters

    Returns Promise<CreateMfaTotpDeviceResponse>

    CreateMfaTotpDeviceResponse

createNetworkSource

  • Creates a new network source in your tenancy.

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

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

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateNetworkSource API.

    Parameters

    Returns Promise<CreateNetworkSourceResponse>

    CreateNetworkSourceResponse

createOAuthClientCredential

createOrResetUIPassword

  • Creates a new Console one-time password for the specified user. For more information about user credentials, see User Credentials.

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

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

    *Note:** The user's Console login is the unique name you specified when you created the user (see {@link #createUser(CreateUserRequest) createUser}).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateOrResetUIPassword API.

    Parameters

    Returns Promise<CreateOrResetUIPasswordResponse>

    CreateOrResetUIPasswordResponse

createPolicy

  • Creates a new policy in the specified compartment (either the tenancy or another of your compartments). If you're new to policies, see Get Started with Policies.

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

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

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

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

    New policies take effect typically within 10 seconds.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePolicy API.

    Parameters

    Returns Promise<CreatePolicyResponse>

    CreatePolicyResponse

createRegionSubscription

createSmtpCredential

  • 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}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSmtpCredential API.

    Parameters

    Returns Promise<CreateSmtpCredentialResponse>

    CreateSmtpCredentialResponse

createSwiftPassword

  • Deprecated. Use {@link #createAuthToken(CreateAuthTokenRequest) createAuthToken} instead.

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSwiftPassword API.

    Parameters

    Returns Promise<CreateSwiftPasswordResponse>

    CreateSwiftPasswordResponse

createTag

  • Creates a new tag in the specified tag namespace.

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

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

    The tag must have a *description*. It does not have to be unique, and you can change it with {@link #updateTag(UpdateTagRequest) updateTag}.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTag API.

    Parameters

    Returns Promise<CreateTagResponse>

    CreateTagResponse

createTagDefault

  • Creates a new tag default in the specified compartment for the specified tag definition.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTagDefault API.

    Parameters

    Returns Promise<CreateTagDefaultResponse>

    CreateTagDefaultResponse

createTagNamespace

  • Creates a new tag namespace in the specified compartment.

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

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

    You must also specify a *description* for the namespace. It does not have to be unique, and you can change it with {@link #updateTagNamespace(UpdateTagNamespaceRequest) updateTagNamespace}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTagNamespace API.

    Parameters

    Returns Promise<CreateTagNamespaceResponse>

    CreateTagNamespaceResponse

createUser

  • Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other IAM Service components, see Overview of IAM.

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

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

    You must also specify a *description* for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with {@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.

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

    A new user has no permissions until you place the user in one or more groups (see {@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](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm) and also {@link #uploadApiKey(UploadApiKeyRequest) uploadApiKey}).

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateUser API.

    Parameters

    Returns Promise<CreateUserResponse>

    CreateUserResponse

createWaiters

  • Creates a new IdentityWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns IdentityWaiter

    The service waiters.

deactivateDomain

  • (For tenancies that support identity domains) Deactivates the specified identity domain. Identity domains must be in an ACTIVE lifecycleState and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate the default identity domain.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeactivateDomain API.

    Parameters

    Returns Promise<DeactivateDomainResponse>

    DeactivateDomainResponse

deleteApiKey

  • Deletes the specified API signing key for the specified user.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteApiKey API.

    Parameters

    Returns Promise<DeleteApiKeyResponse>

    DeleteApiKeyResponse

deleteAuthToken

  • Deletes the specified auth token for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAuthToken API.

    Parameters

    Returns Promise<DeleteAuthTokenResponse>

    DeleteAuthTokenResponse

deleteCompartment

  • Deletes the specified compartment. The compartment must be empty.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCompartment API.

    Parameters

    Returns Promise<DeleteCompartmentResponse>

    DeleteCompartmentResponse

deleteCustomerSecretKey

deleteDbCredential

  • Deletes the specified DB credential for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDbCredential API.

    Parameters

    Returns Promise<DeleteDbCredentialResponse>

    DeleteDbCredentialResponse

deleteDomain

  • (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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDomain API.

    Parameters

    Returns Promise<DeleteDomainResponse>

    DeleteDomainResponse

deleteDynamicGroup

  • Deletes the specified dynamic group.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDynamicGroup API.

    Parameters

    Returns Promise<DeleteDynamicGroupResponse>

    DeleteDynamicGroupResponse

deleteGroup

  • Deletes the specified group. The group must be empty.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteGroup API.

    Parameters

    Returns Promise<DeleteGroupResponse>

    DeleteGroupResponse

deleteIdentityProvider

deleteIdpGroupMapping

deleteMfaTotpDevice

  • Deletes the specified MFA TOTP device for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteMfaTotpDevice API.

    Parameters

    Returns Promise<DeleteMfaTotpDeviceResponse>

    DeleteMfaTotpDeviceResponse

deleteNetworkSource

deleteOAuthClientCredential

deletePolicy

  • Deletes the specified policy. The deletion takes effect typically within 10 seconds. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeletePolicy API.

    Parameters

    Returns Promise<DeletePolicyResponse>

    DeletePolicyResponse

deleteSmtpCredential

  • Deletes the specified SMTP credential for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSmtpCredential API.

    Parameters

    Returns Promise<DeleteSmtpCredentialResponse>

    DeleteSmtpCredentialResponse

deleteSwiftPassword

  • Deprecated. Use {@link #deleteAuthToken(DeleteAuthTokenRequest) deleteAuthToken} instead.

    Deletes the specified Swift password for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSwiftPassword API.

    Parameters

    Returns Promise<DeleteSwiftPasswordResponse>

    DeleteSwiftPasswordResponse

deleteTag

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

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

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

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

    After you start this operation, you cannot start either the {@link #bulkDeleteTags(BulkDeleteTagsRequest) bulkDeleteTags} or the {@link #cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest) cascadeDeleteTagNamespace} operation until this process completes.

    To delete a tag, you must first retire it. Use {@link #updateTag(UpdateTagRequest) updateTag} to retire a tag.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTag API.

    Parameters

    Returns Promise<DeleteTagResponse>

    DeleteTagResponse

deleteTagDefault

  • Deletes the the specified tag default.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTagDefault API.

    Parameters

    Returns Promise<DeleteTagDefaultResponse>

    DeleteTagDefaultResponse

deleteTagNamespace

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

    Use {@link #cascadeDeleteTagNamespace(CascadeDeleteTagNamespaceRequest) cascadeDeleteTagNamespace} to delete a tag namespace along with all of the tag definitions contained within that namespace.

    Use {@link #deleteTag(DeleteTagRequest) deleteTag} to delete a tag definition.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTagNamespace API.

    Parameters

    Returns Promise<DeleteTagNamespaceResponse>

    DeleteTagNamespaceResponse

deleteUser

  • Deletes the specified user. The user must not be in any groups. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteUser API.

    Parameters

    Returns Promise<DeleteUserResponse>

    DeleteUserResponse

enableReplicationToRegion

  • (For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the tenancy home region or other region that the tenancy subscribes to). You can only replicate identity domains that are in an ACTIVE lifecycleState and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains. The default identity domain is automatically replicated to all regions that the tenancy subscribes to.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableReplicationToRegion API.

    Parameters

    Returns Promise<EnableReplicationToRegionResponse>

    EnableReplicationToRegionResponse

generateTotpSeed

  • Generate seed for the MFA TOTP device.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateTotpSeed API.

    Parameters

    Returns Promise<GenerateTotpSeedResponse>

    GenerateTotpSeedResponse

getAuthenticationPolicy

  • 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).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAuthenticationPolicy API.

    Parameters

    Returns Promise<GetAuthenticationPolicyResponse>

    GetAuthenticationPolicyResponse

getCompartment

  • Gets the specified compartment's information.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCompartment API.

    Parameters

    Returns Promise<GetCompartmentResponse>

    GetCompartmentResponse

getDomain

  • (For tenancies that support identity domains) Gets the specified identity domain's information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDomain API.

    Parameters

    Returns Promise<GetDomainResponse>

    GetDomainResponse

getDynamicGroup

  • Gets the specified dynamic group's information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDynamicGroup API.

    Parameters

    Returns Promise<GetDynamicGroupResponse>

    GetDynamicGroupResponse

getGroup

  • Gets the specified group's information.

    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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetGroup API.

    Parameters

    Returns Promise<GetGroupResponse>

    GetGroupResponse

getIamWorkRequest

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIamWorkRequest API.

    Parameters

    Returns Promise<GetIamWorkRequestResponse>

    GetIamWorkRequestResponse

getIdentityProvider

getIdpGroupMapping

getMfaTotpDevice

  • Get the specified MFA TOTP device for the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMfaTotpDevice API.

    Parameters

    Returns Promise<GetMfaTotpDeviceResponse>

    GetMfaTotpDeviceResponse

getNetworkSource

  • Gets the specified network source's information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetNetworkSource API.

    Parameters

    Returns Promise<GetNetworkSourceResponse>

    GetNetworkSourceResponse

getPolicy

  • Gets the specified policy's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPolicy API.

    Parameters

    Returns Promise<GetPolicyResponse>

    GetPolicyResponse

getStandardTagTemplate

  • Retrieve the standard tag namespace template given the standard tag namespace name.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetStandardTagTemplate API.

    Parameters

    Returns Promise<GetStandardTagTemplateResponse>

    GetStandardTagTemplateResponse

getTag

  • Gets the specified tag's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTag API.

    Parameters

    Returns Promise<GetTagResponse>

    GetTagResponse

getTagDefault

  • Retrieves the specified tag default.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTagDefault API.

    Parameters

    Returns Promise<GetTagDefaultResponse>

    GetTagDefaultResponse

getTagNamespace

  • Gets the specified tag namespace's information.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTagNamespace API.

    Parameters

    Returns Promise<GetTagNamespaceResponse>

    GetTagNamespaceResponse

getTaggingWorkRequest

  • Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in tagging service.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTaggingWorkRequest API.

    Parameters

    Returns Promise<GetTaggingWorkRequestResponse>

    GetTaggingWorkRequestResponse

getTenancy

  • Get the specified tenancy's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTenancy API.

    Parameters

    Returns Promise<GetTenancyResponse>

    GetTenancyResponse

getUser

  • Gets the specified user's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUser API.

    Parameters

    Returns Promise<GetUserResponse>

    GetUserResponse

getUserGroupMembership

getUserUIPasswordInformation

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUserUIPasswordInformation API.

    Parameters

    Returns Promise<GetUserUIPasswordInformationResponse>

    GetUserUIPasswordInformationResponse

getWaiters

getWorkRequest

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

importStandardTags

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ImportStandardTags API.

    Parameters

    Returns Promise<ImportStandardTagsResponse>

    ImportStandardTagsResponse

listAllCompartments

  • NOTE: This function is deprecated in favor of listCompartmentsRecordIterator function. Creates a new async iterator which will iterate over the models.Compartment objects contained in responses from the listCompartments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Compartment>

listAllCompartmentsResponses

  • NOTE: This function is deprecated in favor of listCompartmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCompartments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCompartmentsResponse>

listAllCostTrackingTags

  • NOTE: This function is deprecated in favor of listCostTrackingTagsRecordIterator function. Creates a new async iterator which will iterate over the models.Tag objects contained in responses from the listCostTrackingTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Tag>

listAllCostTrackingTagsResponses

  • NOTE: This function is deprecated in favor of listCostTrackingTagsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCostTrackingTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCostTrackingTagsResponse>

listAllDbCredentials

  • NOTE: This function is deprecated in favor of listDbCredentialsRecordIterator function. Creates a new async iterator which will iterate over the models.DbCredentialSummary objects contained in responses from the listDbCredentials operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbCredentialSummary>

listAllDbCredentialsResponses

  • NOTE: This function is deprecated in favor of listDbCredentialsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbCredentials operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbCredentialsResponse>

listAllDomains

  • NOTE: This function is deprecated in favor of listDomainsRecordIterator function. Creates a new async iterator which will iterate over the models.DomainSummary objects contained in responses from the listDomains operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DomainSummary>

listAllDomainsResponses

  • NOTE: This function is deprecated in favor of listDomainsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDomains operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDomainsResponse>

listAllDynamicGroups

  • NOTE: This function is deprecated in favor of listDynamicGroupsRecordIterator function. Creates a new async iterator which will iterate over the models.DynamicGroup objects contained in responses from the listDynamicGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DynamicGroup>

listAllDynamicGroupsResponses

  • NOTE: This function is deprecated in favor of listDynamicGroupsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDynamicGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDynamicGroupsResponse>

listAllGroups

  • NOTE: This function is deprecated in favor of listGroupsRecordIterator function. Creates a new async iterator which will iterate over the models.Group objects contained in responses from the listGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Group>

listAllGroupsResponses

  • NOTE: This function is deprecated in favor of listGroupsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGroupsResponse>

listAllIamWorkRequestErrors

  • NOTE: This function is deprecated in favor of listIamWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.IamWorkRequestErrorSummary objects contained in responses from the listIamWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IamWorkRequestErrorSummary>

listAllIamWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listIamWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIamWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIamWorkRequestErrorsResponse>

listAllIamWorkRequestLogs

  • NOTE: This function is deprecated in favor of listIamWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.IamWorkRequestLogSummary objects contained in responses from the listIamWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IamWorkRequestLogSummary>

listAllIamWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listIamWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIamWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIamWorkRequestLogsResponse>

listAllIamWorkRequests

  • NOTE: This function is deprecated in favor of listIamWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.IamWorkRequestSummary objects contained in responses from the listIamWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IamWorkRequestSummary>

listAllIamWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listIamWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIamWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIamWorkRequestsResponse>

listAllIdentityProviderGroups

  • NOTE: This function is deprecated in favor of listIdentityProviderGroupsRecordIterator function. Creates a new async iterator which will iterate over the models.IdentityProviderGroupSummary objects contained in responses from the listIdentityProviderGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IdentityProviderGroupSummary>

listAllIdentityProviderGroupsResponses

  • NOTE: This function is deprecated in favor of listIdentityProviderGroupsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIdentityProviderGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIdentityProviderGroupsResponse>

listAllIdentityProviders

  • NOTE: This function is deprecated in favor of listIdentityProvidersRecordIterator function. Creates a new async iterator which will iterate over the models.IdentityProvider objects contained in responses from the listIdentityProviders operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IdentityProvider>

listAllIdentityProvidersResponses

  • NOTE: This function is deprecated in favor of listIdentityProvidersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIdentityProviders operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIdentityProvidersResponse>

listAllIdpGroupMappings

  • NOTE: This function is deprecated in favor of listIdpGroupMappingsRecordIterator function. Creates a new async iterator which will iterate over the models.IdpGroupMapping objects contained in responses from the listIdpGroupMappings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IdpGroupMapping>

listAllIdpGroupMappingsResponses

  • NOTE: This function is deprecated in favor of listIdpGroupMappingsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIdpGroupMappings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIdpGroupMappingsResponse>

listAllMfaTotpDevices

  • NOTE: This function is deprecated in favor of listMfaTotpDevicesRecordIterator function. Creates a new async iterator which will iterate over the models.MfaTotpDeviceSummary objects contained in responses from the listMfaTotpDevices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MfaTotpDeviceSummary>

listAllMfaTotpDevicesResponses

  • NOTE: This function is deprecated in favor of listMfaTotpDevicesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMfaTotpDevices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListMfaTotpDevicesResponse>

listAllNetworkSources

  • NOTE: This function is deprecated in favor of listNetworkSourcesRecordIterator function. Creates a new async iterator which will iterate over the models.NetworkSourcesSummary objects contained in responses from the listNetworkSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NetworkSourcesSummary>

listAllNetworkSourcesResponses

  • NOTE: This function is deprecated in favor of listNetworkSourcesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listNetworkSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListNetworkSourcesResponse>

listAllOAuthClientCredentials

  • NOTE: This function is deprecated in favor of listOAuthClientCredentialsRecordIterator function. Creates a new async iterator which will iterate over the models.OAuth2ClientCredentialSummary objects contained in responses from the listOAuthClientCredentials operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<OAuth2ClientCredentialSummary>

listAllOAuthClientCredentialsResponses

  • NOTE: This function is deprecated in favor of listOAuthClientCredentialsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listOAuthClientCredentials operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListOAuthClientCredentialsResponse>

listAllPolicies

  • NOTE: This function is deprecated in favor of listPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.Policy objects contained in responses from the listPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Policy>

listAllPoliciesResponses

  • NOTE: This function is deprecated in favor of listPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPoliciesResponse>

listAllStandardTagNamespaces

  • NOTE: This function is deprecated in favor of listStandardTagNamespacesRecordIterator function. Creates a new async iterator which will iterate over the models.StandardTagNamespaceTemplateSummary objects contained in responses from the listStandardTagNamespaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<StandardTagNamespaceTemplateSummary>

listAllStandardTagNamespacesResponses

  • NOTE: This function is deprecated in favor of listStandardTagNamespacesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listStandardTagNamespaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListStandardTagNamespacesResponse>

listAllTagDefaults

  • NOTE: This function is deprecated in favor of listTagDefaultsRecordIterator function. Creates a new async iterator which will iterate over the models.TagDefaultSummary objects contained in responses from the listTagDefaults operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TagDefaultSummary>

listAllTagDefaultsResponses

  • NOTE: This function is deprecated in favor of listTagDefaultsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTagDefaults operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTagDefaultsResponse>

listAllTagNamespaces

  • NOTE: This function is deprecated in favor of listTagNamespacesRecordIterator function. Creates a new async iterator which will iterate over the models.TagNamespaceSummary objects contained in responses from the listTagNamespaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TagNamespaceSummary>

listAllTagNamespacesResponses

  • NOTE: This function is deprecated in favor of listTagNamespacesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTagNamespaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTagNamespacesResponse>

listAllTaggingWorkRequestErrors

  • NOTE: This function is deprecated in favor of listTaggingWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.TaggingWorkRequestErrorSummary objects contained in responses from the listTaggingWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TaggingWorkRequestErrorSummary>

listAllTaggingWorkRequestErrorsResponses

listAllTaggingWorkRequestLogs

  • NOTE: This function is deprecated in favor of listTaggingWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.TaggingWorkRequestLogSummary objects contained in responses from the listTaggingWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TaggingWorkRequestLogSummary>

listAllTaggingWorkRequestLogsResponses

listAllTaggingWorkRequests

  • NOTE: This function is deprecated in favor of listTaggingWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.TaggingWorkRequestSummary objects contained in responses from the listTaggingWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TaggingWorkRequestSummary>

listAllTaggingWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listTaggingWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTaggingWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTaggingWorkRequestsResponse>

listAllTags

  • NOTE: This function is deprecated in favor of listTagsRecordIterator function. Creates a new async iterator which will iterate over the models.TagSummary objects contained in responses from the listTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListTagsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<TagSummary>

listAllTagsResponses

  • NOTE: This function is deprecated in favor of listTagsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListTagsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListTagsResponse>

listAllUserGroupMemberships

  • NOTE: This function is deprecated in favor of listUserGroupMembershipsRecordIterator function. Creates a new async iterator which will iterate over the models.UserGroupMembership objects contained in responses from the listUserGroupMemberships operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UserGroupMembership>

listAllUserGroupMembershipsResponses

  • NOTE: This function is deprecated in favor of listUserGroupMembershipsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listUserGroupMemberships operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListUserGroupMembershipsResponse>

listAllUsers

  • NOTE: This function is deprecated in favor of listUsersRecordIterator function. Creates a new async iterator which will iterate over the models.User objects contained in responses from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<User>

listAllUsersResponses

  • NOTE: This function is deprecated in favor of listUsersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListUsersResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAllowedDomainLicenseTypes

  • (For tenancies that support identity domains) Lists the license types for identity domains supported by Oracle Cloud Infrastructure. (License types are also referred to as domain types.)

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAllowedDomainLicenseTypes API.

    Parameters

    Returns Promise<ListAllowedDomainLicenseTypesResponse>

    ListAllowedDomainLicenseTypesResponse

listApiKeys

  • Lists the API signing keys for the specified user. A user can have a maximum of three keys.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListApiKeys API.

    Parameters

    Returns Promise<ListApiKeysResponse>

    ListApiKeysResponse

listAuthTokens

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuthTokens API.

    Parameters

    Returns Promise<ListAuthTokensResponse>

    ListAuthTokensResponse

listAvailabilityDomains

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAvailabilityDomains API.

    Parameters

    Returns Promise<ListAvailabilityDomainsResponse>

    ListAvailabilityDomainsResponse

listBulkActionResourceTypes

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBulkActionResourceTypes API.

    Parameters

    Returns Promise<ListBulkActionResourceTypesResponse>

    ListBulkActionResourceTypesResponse

listBulkEditTagsResourceTypes

listCompartments

  • Lists the compartments in a specified compartment. The members of the list returned depends on the values set for several parameters.

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

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCompartments API.

    Parameters

    Returns Promise<ListCompartmentsResponse>

    ListCompartmentsResponse

listCompartmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.Compartment objects contained in responses from the listCompartments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Compartment>

listCompartmentsResponseIterator

listCostTrackingTags

listCostTrackingTagsRecordIterator

  • Creates a new async iterator which will iterate over the models.Tag objects contained in responses from the listCostTrackingTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Tag>

listCostTrackingTagsResponseIterator

listCustomerSecretKeys

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCustomerSecretKeys API.

    Parameters

    Returns Promise<ListCustomerSecretKeysResponse>

    ListCustomerSecretKeysResponse

listDbCredentials

  • Lists the DB credentials for the specified user. The returned object contains the credential's OCID

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbCredentials API.

    Parameters

    Returns Promise<ListDbCredentialsResponse>

    ListDbCredentialsResponse

listDbCredentialsRecordIterator

  • Creates a new async iterator which will iterate over the models.DbCredentialSummary objects contained in responses from the listDbCredentials operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbCredentialSummary>

listDbCredentialsResponseIterator

listDomains

  • (For tenancies that support identity domains) Lists all identity domains within a tenancy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDomains API.

    Parameters

    Returns Promise<ListDomainsResponse>

    ListDomainsResponse

listDomainsRecordIterator

  • Creates a new async iterator which will iterate over the models.DomainSummary objects contained in responses from the listDomains operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DomainSummary>

listDomainsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listDomains operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDomainsResponse>

listDynamicGroups

listDynamicGroupsRecordIterator

  • Creates a new async iterator which will iterate over the models.DynamicGroup objects contained in responses from the listDynamicGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DynamicGroup>

listDynamicGroupsResponseIterator

listFaultDomains

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFaultDomains API.

    Parameters

    Returns Promise<ListFaultDomainsResponse>

    ListFaultDomainsResponse

listGroups

listGroupsRecordIterator

  • Creates a new async iterator which will iterate over the models.Group objects contained in responses from the listGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Group>

listGroupsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGroupsResponse>

listIamWorkRequestErrors

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIamWorkRequestErrors API.

    Parameters

    Returns Promise<ListIamWorkRequestErrorsResponse>

    ListIamWorkRequestErrorsResponse

listIamWorkRequestErrorsRecordIterator

listIamWorkRequestErrorsResponseIterator

listIamWorkRequestLogs

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIamWorkRequestLogs API.

    Parameters

    Returns Promise<ListIamWorkRequestLogsResponse>

    ListIamWorkRequestLogsResponse

listIamWorkRequestLogsRecordIterator

listIamWorkRequestLogsResponseIterator

listIamWorkRequests

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIamWorkRequests API.

    Parameters

    Returns Promise<ListIamWorkRequestsResponse>

    ListIamWorkRequestsResponse

listIamWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.IamWorkRequestSummary objects contained in responses from the listIamWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IamWorkRequestSummary>

listIamWorkRequestsResponseIterator

listIdentityProviderGroups

listIdentityProviderGroupsRecordIterator

listIdentityProviderGroupsResponseIterator

listIdentityProviders

  • Deprecated. For more information, see Deprecated IAM Service APIs.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIdentityProviders API.

    Parameters

    Returns Promise<ListIdentityProvidersResponse>

    ListIdentityProvidersResponse

listIdentityProvidersRecordIterator

  • Creates a new async iterator which will iterate over the models.IdentityProvider objects contained in responses from the listIdentityProviders operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IdentityProvider>

listIdentityProvidersResponseIterator

listIdpGroupMappings

listIdpGroupMappingsRecordIterator

  • Creates a new async iterator which will iterate over the models.IdpGroupMapping objects contained in responses from the listIdpGroupMappings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IdpGroupMapping>

listIdpGroupMappingsResponseIterator

listMfaTotpDevices

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMfaTotpDevices API.

    Parameters

    Returns Promise<ListMfaTotpDevicesResponse>

    ListMfaTotpDevicesResponse

listMfaTotpDevicesRecordIterator

  • Creates a new async iterator which will iterate over the models.MfaTotpDeviceSummary objects contained in responses from the listMfaTotpDevices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MfaTotpDeviceSummary>

listMfaTotpDevicesResponseIterator

listNetworkSources

listNetworkSourcesRecordIterator

  • Creates a new async iterator which will iterate over the models.NetworkSourcesSummary objects contained in responses from the listNetworkSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NetworkSourcesSummary>

listNetworkSourcesResponseIterator

listOAuthClientCredentials

listOAuthClientCredentialsRecordIterator

listOAuthClientCredentialsResponseIterator

listPolicies

  • Lists the policies in the specified compartment (either the tenancy or another of your compartments). See Where to Get the Tenancy's OCID and User's OCID.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPolicies API.

    Parameters

    Returns Promise<ListPoliciesResponse>

    ListPoliciesResponse

listPoliciesRecordIterator

  • Creates a new async iterator which will iterate over the models.Policy objects contained in responses from the listPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Policy>

listPoliciesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPoliciesResponse>

listRegionSubscriptions

listRegions

  • Lists all the regions offered by Oracle Cloud Infrastructure. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRegions API.

    Parameters

    Returns Promise<ListRegionsResponse>

    ListRegionsResponse

listSmtpCredentials

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSmtpCredentials API.

    Parameters

    Returns Promise<ListSmtpCredentialsResponse>

    ListSmtpCredentialsResponse

listStandardTagNamespaces

listStandardTagNamespacesRecordIterator

listStandardTagNamespacesResponseIterator

listSwiftPasswords

  • Deprecated. Use {@link #listAuthTokens(ListAuthTokensRequest) listAuthTokens} instead.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSwiftPasswords API.

    Parameters

    Returns Promise<ListSwiftPasswordsResponse>

    ListSwiftPasswordsResponse

listTagDefaults

  • Lists the tag defaults for tag definitions in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTagDefaults API.

    Parameters

    Returns Promise<ListTagDefaultsResponse>

    ListTagDefaultsResponse

listTagDefaultsRecordIterator

  • Creates a new async iterator which will iterate over the models.TagDefaultSummary objects contained in responses from the listTagDefaults operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TagDefaultSummary>

listTagDefaultsResponseIterator

listTagNamespaces

  • Lists the tag namespaces in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTagNamespaces API.

    Parameters

    Returns Promise<ListTagNamespacesResponse>

    ListTagNamespacesResponse

listTagNamespacesRecordIterator

  • Creates a new async iterator which will iterate over the models.TagNamespaceSummary objects contained in responses from the listTagNamespaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TagNamespaceSummary>

listTagNamespacesResponseIterator

listTaggingWorkRequestErrors

listTaggingWorkRequestErrorsRecordIterator

listTaggingWorkRequestErrorsResponseIterator

listTaggingWorkRequestLogs

listTaggingWorkRequestLogsRecordIterator

listTaggingWorkRequestLogsResponseIterator

listTaggingWorkRequests

listTaggingWorkRequestsRecordIterator

listTaggingWorkRequestsResponseIterator

listTags

  • Lists the tag definitions in the specified tag namespace.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTags API.

    Parameters

    Returns Promise<ListTagsResponse>

    ListTagsResponse

listTagsRecordIterator

  • Creates a new async iterator which will iterate over the models.TagSummary objects contained in responses from the listTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListTagsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<TagSummary>

listTagsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listTags operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListTagsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListTagsResponse>

listUserGroupMemberships

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListUserGroupMemberships API.

    Parameters

    Returns Promise<ListUserGroupMembershipsResponse>

    ListUserGroupMembershipsResponse

listUserGroupMembershipsRecordIterator

  • Creates a new async iterator which will iterate over the models.UserGroupMembership objects contained in responses from the listUserGroupMemberships operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UserGroupMembership>

listUserGroupMembershipsResponseIterator

listUsers

listUsersRecordIterator

  • Creates a new async iterator which will iterate over the models.User objects contained in responses from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<User>

listUsersResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listUsers operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListUsersRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListUsersResponse>

listWorkRequests

  • Lists the work requests in compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

moveCompartment

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use MoveCompartment API.

    Parameters

    Returns Promise<MoveCompartmentResponse>

    MoveCompartmentResponse

recoverCompartment

  • Recover the compartment from DELETED state to ACTIVE state.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RecoverCompartment API.

    Parameters

    Returns Promise<RecoverCompartmentResponse>

    RecoverCompartmentResponse

removeTagDefaultLock

removeTagNamespaceLock

removeUserFromGroup

  • Removes a user from a group by deleting the corresponding UserGroupMembership. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveUserFromGroup API.

    Parameters

    Returns Promise<RemoveUserFromGroupResponse>

    RemoveUserFromGroupResponse

resetIdpScimClient

  • Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResetIdpScimClient API.

    Parameters

    Returns Promise<ResetIdpScimClientResponse>

    ResetIdpScimClientResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAuthToken

  • Updates the specified auth token's description.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAuthToken API.

    Parameters

    Returns Promise<UpdateAuthTokenResponse>

    UpdateAuthTokenResponse

updateAuthenticationPolicy

updateCompartment

  • Updates the specified compartment's description or name. You can't update the root compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCompartment API.

    Parameters

    Returns Promise<UpdateCompartmentResponse>

    UpdateCompartmentResponse

updateCustomerSecretKey

updateDomain

  • (For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDomain API.

    Parameters

    Returns Promise<UpdateDomainResponse>

    UpdateDomainResponse

updateDynamicGroup

updateGroup

  • Updates the specified group. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateGroup API.

    Parameters

    Returns Promise<UpdateGroupResponse>

    UpdateGroupResponse

updateIdentityProvider

updateIdpGroupMapping

updateNetworkSource

updateOAuthClientCredential

updatePolicy

  • Updates the specified policy. You can update the description or the policy statements themselves.

    Policy changes take effect typically within 10 seconds.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdatePolicy API.

    Parameters

    Returns Promise<UpdatePolicyResponse>

    UpdatePolicyResponse

updateSmtpCredential

  • Updates the specified SMTP credential's description.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSmtpCredential API.

    Parameters

    Returns Promise<UpdateSmtpCredentialResponse>

    UpdateSmtpCredentialResponse

updateSwiftPassword

  • Deprecated. Use {@link #updateAuthToken(UpdateAuthTokenRequest) updateAuthToken} instead.

    Updates the specified Swift password's description.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSwiftPassword API.

    Parameters

    Returns Promise<UpdateSwiftPasswordResponse>

    UpdateSwiftPasswordResponse

updateTag

  • Updates the specified tag definition.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTag API.

    Parameters

    Returns Promise<UpdateTagResponse>

    UpdateTagResponse

updateTagDefault

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTagDefault API.

    Parameters

    Returns Promise<UpdateTagDefaultResponse>

    UpdateTagDefaultResponse

updateTagNamespace

  • Updates the the specified tag namespace. You can't update the namespace name.

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTagNamespace API.

    Parameters

    Returns Promise<UpdateTagNamespaceResponse>

    UpdateTagNamespaceResponse

updateUser

  • Updates the description of the specified user. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateUser API.

    Parameters

    Returns Promise<UpdateUserResponse>

    UpdateUserResponse

updateUserCapabilities

updateUserState

  • Updates the state of the specified user.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateUserState API.

    Parameters

    Returns Promise<UpdateUserStateResponse>

    UpdateUserStateResponse

uploadApiKey

  • Uploads an API signing key for the specified user.

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

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

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UploadApiKey API.

    Parameters

    Returns Promise<UploadApiKeyResponse>

    UploadApiKeyResponse