IdentityClient

class oci.identity.IdentityClient(config, **kwargs)

APIs for managing users, groups, compartments, and policies.

Methods

__init__(config, **kwargs) Creates a new service client
activate_mfa_totp_device(user_id, …) Activates the specified MFA TOTP device for the user.
add_user_to_group(add_user_to_group_details, …) Adds the specified user to the specified group and returns a UserGroupMembership object with its own OCID.
assemble_effective_tag_set(compartment_id, …) Assembles tag defaults in the specified compartment and any parent compartments to determine the tags to apply.
bulk_delete_resources(compartment_id, …) Deletes multiple resources in the compartment.
bulk_delete_tags(bulk_delete_tags_details, …) Deletes the specified tag key definitions.
bulk_move_resources(compartment_id, …) Moves multiple resources from one compartment to another.
cascade_delete_tag_namespace(…) Deletes the specified tag namespace.
change_tag_namespace_compartment(…) Moves the specified tag namespace to the specified compartment within the same tenancy.
create_auth_token(create_auth_token_details, …) Creates a new auth token for the specified user.
create_compartment(…) Creates a new compartment in the specified compartment.
create_customer_secret_key(…) Creates a new secret key for the specified user.
create_dynamic_group(…) Creates a new dynamic group in your tenancy.
create_group(create_group_details, **kwargs) Creates a new group in your tenancy.
create_identity_provider(…) Creates a new identity provider in your tenancy.
create_idp_group_mapping(…) Creates a single mapping between an IdP group and an IAM Service Group.
create_mfa_totp_device(user_id, **kwargs) Creates a new MFA TOTP device for the user.
create_network_source(…) Creates a new network source in your tenancy.
create_o_auth_client_credential(user_id, …) Creates Oauth token for the user
create_or_reset_ui_password(user_id, **kwargs) Creates a new Console one-time password for the specified user.
create_policy(create_policy_details, **kwargs) Creates a new policy in the specified compartment (either the tenancy or another of your compartments).
create_region_subscription(…) Creates a subscription to a region for a tenancy.
create_smtp_credential(…) Creates a new SMTP credential for the specified user.
create_swift_password(…) Deprecated. Use :func:`create_auth_token` instead.
create_tag(tag_namespace_id, …) Creates a new tag in the specified tag namespace.
create_tag_default(…) Creates a new tag default in the specified compartment for the specified tag definition.
create_tag_namespace(…) Creates a new tag namespace in the specified compartment.
create_user(create_user_details, **kwargs) Creates a new user in your tenancy.
delete_api_key(user_id, fingerprint, **kwargs) Deletes the specified API signing key for the specified user.
delete_auth_token(user_id, auth_token_id, …) Deletes the specified auth token for the specified user.
delete_compartment(compartment_id, **kwargs) Deletes the specified compartment.
delete_customer_secret_key(user_id, …) Deletes the specified secret key for the specified user.
delete_dynamic_group(dynamic_group_id, **kwargs) Deletes the specified dynamic group.
delete_group(group_id, **kwargs) Deletes the specified group.
delete_identity_provider(…) Deletes the specified identity provider.
delete_idp_group_mapping(…) Deletes the specified group mapping.
delete_mfa_totp_device(user_id, …) Deletes the specified MFA TOTP device for the specified user.
delete_network_source(network_source_id, …) Deletes the specified network source
delete_o_auth_client_credential(user_id, …) Delete Oauth token for the user
delete_policy(policy_id, **kwargs) Deletes the specified policy.
delete_smtp_credential(user_id, …) Deletes the specified SMTP credential for the specified user.
delete_swift_password(user_id, …) Deprecated. Use :func:`delete_auth_token` instead.
delete_tag(tag_namespace_id, tag_name, **kwargs) Deletes the specified tag definition.
delete_tag_default(tag_default_id, **kwargs) Deletes the the specified tag default.
delete_tag_namespace(tag_namespace_id, **kwargs) Deletes the specified tag namespace.
delete_user(user_id, **kwargs) Deletes the specified user.
generate_totp_seed(user_id, …) Generate seed for the MFA TOTP device.
get_authentication_policy(compartment_id, …) Gets the authentication policy for the given tenancy.
get_compartment(compartment_id, **kwargs) Gets the specified compartment’s information.
get_dynamic_group(dynamic_group_id, **kwargs) Gets the specified dynamic group’s information.
get_group(group_id, **kwargs) Gets the specified group’s information.
get_identity_provider(identity_provider_id, …) Gets the specified identity provider’s information.
get_idp_group_mapping(identity_provider_id, …) Gets the specified group mapping.
get_mfa_totp_device(user_id, …) Get the specified MFA TOTP device for the specified user.
get_network_source(network_source_id, **kwargs) Gets the specified network source’s information.
get_policy(policy_id, **kwargs) Gets the specified policy’s information.
get_tag(tag_namespace_id, tag_name, **kwargs) Gets the specified tag’s information.
get_tag_default(tag_default_id, **kwargs) Retrieves the specified tag default.
get_tag_namespace(tag_namespace_id, **kwargs) Gets the specified tag namespace’s information.
get_tagging_work_request(work_request_id, …) Gets details on a specified work request.
get_tenancy(tenancy_id, **kwargs) Get the specified tenancy’s information.
get_user(user_id, **kwargs) Gets the specified user’s information.
get_user_group_membership(…) Gets the specified UserGroupMembership’s information.
get_user_ui_password_information(user_id, …) Gets the specified user’s console password information.
get_work_request(work_request_id, **kwargs) Gets details on a specified work request.
list_api_keys(user_id, **kwargs) Lists the API signing keys for the specified user.
list_auth_tokens(user_id, **kwargs) Lists the auth tokens for the specified user.
list_availability_domains(compartment_id, …) Lists the availability domains in your tenancy.
list_bulk_action_resource_types(…) Lists the resource-types supported by compartment bulk actions.
list_compartments(compartment_id, **kwargs) Lists the compartments in a specified compartment.
list_cost_tracking_tags(compartment_id, **kwargs) Lists all the tags enabled for cost-tracking in the specified tenancy.
list_customer_secret_keys(user_id, **kwargs) Lists the secret keys for the specified user.
list_dynamic_groups(compartment_id, **kwargs) Lists the dynamic groups in your tenancy.
list_fault_domains(compartment_id, …) Lists the Fault Domains in your tenancy.
list_groups(compartment_id, **kwargs) Lists the groups in your tenancy.
list_identity_provider_groups(…) Lists the identity provider groups.
list_identity_providers(protocol, …) Lists all the identity providers in your tenancy.
list_idp_group_mappings(…) Lists the group mappings for the specified identity provider.
list_mfa_totp_devices(user_id, **kwargs) Lists the MFA TOTP devices for the specified user.
list_network_sources(compartment_id, **kwargs) Lists the network sources in your tenancy.
list_o_auth_client_credentials(user_id, **kwargs) List of Oauth tokens for the user
list_policies(compartment_id, **kwargs) Lists the policies in the specified compartment (either the tenancy or another of your compartments).
list_region_subscriptions(tenancy_id, **kwargs) Lists the region subscriptions for the specified tenancy.
list_regions(**kwargs) Lists all the regions offered by Oracle Cloud Infrastructure.
list_smtp_credentials(user_id, **kwargs) Lists the SMTP credentials for the specified user.
list_swift_passwords(user_id, **kwargs) Deprecated. Use :func:`list_auth_tokens` instead.
list_tag_defaults(**kwargs) Lists the tag defaults for tag definitions in the specified compartment.
list_tag_namespaces(compartment_id, **kwargs) Lists the tag namespaces in the specified compartment.
list_tagging_work_request_errors(…) Gets the errors for a work request.
list_tagging_work_request_logs(…) Gets the logs for a work request.
list_tagging_work_requests(compartment_id, …) Lists the tagging work requests in compartment.
list_tags(tag_namespace_id, **kwargs) Lists the tag definitions in the specified tag namespace.
list_user_group_memberships(compartment_id, …) Lists the UserGroupMembership objects in your tenancy.
list_users(compartment_id, **kwargs) Lists the users in your tenancy.
list_work_requests(compartment_id, **kwargs) Lists the work requests in compartment.
move_compartment(compartment_id, …) Move the compartment to a different parent compartment in the same tenancy.
recover_compartment(compartment_id, **kwargs) Recover the compartment from DELETED state to ACTIVE state.
remove_user_from_group(…) Removes a user from a group by deleting the corresponding UserGroupMembership.
reset_idp_scim_client(identity_provider_id, …) Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
update_auth_token(user_id, auth_token_id, …) Updates the specified auth token’s description.
update_authentication_policy(compartment_id, …) Updates authentication policy for the specified tenancy
update_compartment(compartment_id, …) Updates the specified compartment’s description or name.
update_customer_secret_key(user_id, …) Updates the specified secret key’s description.
update_dynamic_group(dynamic_group_id, …) Updates the specified dynamic group.
update_group(group_id, update_group_details, …) Updates the specified group.
update_identity_provider(…) Updates the specified identity provider.
update_idp_group_mapping(…) Updates the specified group mapping.
update_network_source(network_source_id, …) Updates the specified network source.
update_o_auth_client_credential(user_id, …) Updates Oauth token for the user
update_policy(policy_id, …) Updates the specified policy.
update_smtp_credential(user_id, …) Updates the specified SMTP credential’s description.
update_swift_password(user_id, …) Deprecated. Use :func:`update_auth_token` instead.
update_tag(tag_namespace_id, tag_name, …) Updates the specified tag definition.
update_tag_default(tag_default_id, …) Updates the specified tag default.
update_tag_namespace(tag_namespace_id, …) Updates the the specified tag namespace.
update_user(user_id, update_user_details, …) Updates the description of the specified user.
update_user_capabilities(user_id, …) Updates the capabilities of the specified user.
update_user_state(user_id, …) Updates the state of the specified user.
upload_api_key(user_id, …) Uploads an API signing key for the specified user.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

activate_mfa_totp_device(user_id, mfa_totp_device_id, mfa_totp_token, **kwargs)

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

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • mfa_totp_device_id (str) – (required) The OCID of the MFA TOTP device.
  • mfa_totp_token (MfaTotpToken) – (required) MFA TOTP token
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MfaTotpDeviceSummary

Return type:

Response

add_user_to_group(add_user_to_group_details, **kwargs)

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.

Parameters:
  • add_user_to_group_details (AddUserToGroupDetails) – (required) Request object for adding a user to a group.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UserGroupMembership

Return type:

Response

assemble_effective_tag_set(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TagDefaultSummary

Return type:

Response

bulk_delete_resources(compartment_id, bulk_delete_resources_details, **kwargs)

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 get_work_request() API to monitor the status of the bulk action.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • bulk_delete_resources_details (BulkDeleteResourcesDetails) – (required) Request object for bulk delete resources in a compartment.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

bulk_delete_tags(bulk_delete_tags_details, **kwargs)

Deletes the specified tag key definitions. This operation triggers a process that removes the tags from all resources in your tenancy.

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 delete_tag() or the cascade_delete_tag_namespace() operation until this process completes.

In order to delete tags, you must first retire the tags. Use update_tag() to retire a tag.

Parameters:
  • bulk_delete_tags_details (BulkDeleteTagsDetails) – (required) Request object for deleting tags in bulk.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

bulk_move_resources(compartment_id, bulk_move_resources_details, **kwargs)

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 get_work_request() API to monitor the status of the bulk action.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • bulk_move_resources_details (BulkMoveResourcesDetails) – (required) Request object for bulk move resources in the compartment.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

cascade_delete_tag_namespace(tag_namespace_id, **kwargs)

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 delete_tag() or the bulk_delete_tags() operation until this process completes.

To delete a tag namespace, you must first retire it. Use update_tag_namespace() to retire a tag namespace.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_tag_namespace_compartment(tag_namespace_id, change_tag_namespace_compartment_detail, **kwargs)

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

To move the tag namespace, you must have the manage tag-namespaces permission on both compartments. For more information about IAM policies, see Details for IAM.

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

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • change_tag_namespace_compartment_detail (ChangeTagNamespaceCompartmentDetail) – (required) Request object for changing the compartment of a tag namespace.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_auth_token(create_auth_token_details, user_id, **kwargs)

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 update_auth_token().

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.

Parameters:
  • create_auth_token_details (CreateAuthTokenDetails) – (required) Request object for creating a new auth token.
  • user_id (str) – (required) The OCID of the user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AuthToken

Return type:

Response

create_compartment(create_compartment_details, **kwargs)

Creates a new compartment in the specified compartment.

Important: Compartments cannot be deleted.

Specify the parent compartment’s OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers.

You must also specify a name for the compartment, which must be unique across all compartments in your tenancy. You can use this name or the OCID when writing policies that apply to the compartment. For more information about policies, see How Policies Work.

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

Parameters:
  • create_compartment_details (CreateCompartmentDetails) – (required) Request object for creating a new compartment.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Compartment

Return type:

Response

create_customer_secret_key(create_customer_secret_key_details, user_id, **kwargs)

Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service’s Amazon S3 compatible API. For information, see Managing User Credentials.

You must specify a description for the secret key (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_customer_secret_key().

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.

Parameters:
  • create_customer_secret_key_details (CreateCustomerSecretKeyDetails) – (required) Request object for creating a new secret key.
  • user_id (str) – (required) The OCID of the user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CustomerSecretKey

Return type:

Response

create_dynamic_group(create_dynamic_group_details, **kwargs)

Creates a new dynamic group in your tenancy.

You must specify your tenancy’s OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers.

You must also specify a name for the dynamic group, which must be unique across all dynamic groups in your tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. You can use this name or the OCID when writing policies that apply to the dynamic group. For more information about policies, see How Policies Work.

You must also specify a description for the dynamic group (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_dynamic_group().

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.

Parameters:
  • create_dynamic_group_details (CreateDynamicGroupDetails) – (required) Request object for creating a new dynamic group.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DynamicGroup

Return type:

Response

create_group(create_group_details, **kwargs)

Creates a new group in your tenancy.

You must specify your tenancy’s OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers.

You must also specify a name for the group, which must be unique across all groups in your tenancy and cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more information about policies, see How Policies Work.

You must also specify a description for the group (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_group().

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 add_user_to_group() and create_policy().

Parameters:
  • create_group_details (CreateGroupDetails) – (required) Request object for creating a new group.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Group

Return type:

Response

create_identity_provider(create_identity_provider_details, **kwargs)

Creates a new identity provider in your tenancy. For more information, see Identity Providers and Federation.

You must specify your tenancy’s OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers.

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

You must also specify a description for the IdentityProvider (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_identity_provider().

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.

Parameters:
  • create_identity_provider_details (CreateIdentityProviderDetails) – (required) Request object for creating a new SAML2 identity provider.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IdentityProvider

Return type:

Response

create_idp_group_mapping(create_idp_group_mapping_details, identity_provider_id, **kwargs)

Creates a single mapping between an IdP group and an IAM Service Group.

Parameters:
  • create_idp_group_mapping_details (CreateIdpGroupMappingDetails) – (required) Add a mapping from an SAML2.0 identity provider group to a BMC group.
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IdpGroupMapping

Return type:

Response

create_mfa_totp_device(user_id, **kwargs)

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

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MfaTotpDevice

Return type:

Response

create_network_source(create_network_source_details, **kwargs)

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.

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.

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 update_network_source().

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.

Parameters:
  • create_network_source_details (CreateNetworkSourceDetails) – (required) Request object for creating a new network source.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkSources

Return type:

Response

create_o_auth_client_credential(user_id, create_o_auth2_client_credential_details, **kwargs)

Creates Oauth token for the user

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • create_o_auth2_client_credential_details (CreateOAuth2ClientCredentialDetails) – (required) Request object containing the information required to generate an Oauth token.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type OAuth2ClientCredential

Return type:

Response

create_or_reset_ui_password(user_id, **kwargs)

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

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

Note: The user’s Console login is the unique name you specified when you created the user (see create_user()).

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UIPassword

Return type:

Response

create_policy(create_policy_details, **kwargs)

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

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

You must also specify a description for the policy (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_policy().

You must specify one or more policy statements in the statements array. For information about writing policies, see How Policies Work and Common Policies.

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

New policies take effect typically within 10 seconds.

Parameters:
  • create_policy_details (CreatePolicyDetails) – (required) Request object for creating a new policy.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Policy

Return type:

Response

create_region_subscription(create_region_subscription_details, tenancy_id, **kwargs)

Creates a subscription to a region for a tenancy.

Parameters:
  • create_region_subscription_details (CreateRegionSubscriptionDetails) – (required) Request object for activate a new region.
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RegionSubscription

Return type:

Response

create_smtp_credential(create_smtp_credential_details, user_id, **kwargs)

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 update_smtp_credential().

Parameters:
  • create_smtp_credential_details (CreateSmtpCredentialDetails) – (required) Request object for creating a new SMTP credential with the user.
  • user_id (str) – (required) The OCID of the user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SmtpCredential

Return type:

Response

create_swift_password(create_swift_password_details, user_id, **kwargs)

Deprecated. Use :func:`create_auth_token` instead.

Creates a new Swift password for the specified user. For information about what Swift passwords are for, see Managing User Credentials.

You must specify a description for the Swift password (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_swift_password().

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.

Parameters:
  • create_swift_password_details (CreateSwiftPasswordDetails) – (required) Request object for creating a new swift password.
  • user_id (str) – (required) The OCID of the user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SwiftPassword

Return type:

Response

create_tag(tag_namespace_id, create_tag_details, **kwargs)

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 update_tag().

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 enum_tag_definition_validator().

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • create_tag_details (CreateTagDetails) – (required) Request object for creating a new tag in the specified tag namespace.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Tag

Return type:

Response

create_tag_default(create_tag_default_details, **kwargs)

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.
Parameters:
  • create_tag_default_details (CreateTagDefaultDetails) – (required) Request object for creating a new tag default.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TagDefault

Return type:

Response

create_tag_namespace(create_tag_namespace_details, **kwargs)

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 update_tag_namespace().

Parameters:
  • create_tag_namespace_details (CreateTagNamespaceDetails) – (required) Request object for creating a new tag namespace.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TagNamespace

Return type:

Response

create_user(create_user_details, **kwargs)

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

You must specify your tenancy’s OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers.

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

You must also specify a description for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_user(). 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 add_user_to_group()). If the user needs to access the Console, you need to provide the user a password (see create_or_reset_ui_password()). If the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a public API signing key for that user (see Required Keys and OCIDs and also upload_api_key()).

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

Parameters:
  • create_user_details (CreateUserDetails) – (required) Request object for creating a new user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type User

Return type:

Response

delete_api_key(user_id, fingerprint, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • fingerprint (str) – (required) The key’s fingerprint.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_auth_token(user_id, auth_token_id, **kwargs)

Deletes the specified auth token for the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • auth_token_id (str) – (required) The OCID of the auth token.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_compartment(compartment_id, **kwargs)

Deletes the specified compartment. The compartment must be empty.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_customer_secret_key(user_id, customer_secret_key_id, **kwargs)

Deletes the specified secret key for the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • customer_secret_key_id (str) – (required) The OCID of the secret key.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_dynamic_group(dynamic_group_id, **kwargs)

Deletes the specified dynamic group.

Parameters:
  • dynamic_group_id (str) – (required) The OCID of the dynamic group.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_group(group_id, **kwargs)

Deletes the specified group. The group must be empty.

Parameters:
  • group_id (str) – (required) The OCID of the group.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_identity_provider(identity_provider_id, **kwargs)

Deletes the specified identity provider. The identity provider must not have any group mappings (see IdpGroupMapping).

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_idp_group_mapping(identity_provider_id, mapping_id, **kwargs)

Deletes the specified group mapping.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • mapping_id (str) – (required) The OCID of the group mapping.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_mfa_totp_device(user_id, mfa_totp_device_id, **kwargs)

Deletes the specified MFA TOTP device for the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • mfa_totp_device_id (str) – (required) The OCID of the MFA TOTP device.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_network_source(network_source_id, **kwargs)

Deletes the specified network source

Parameters:
  • network_source_id (str) – (required) The OCID of the network source.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_o_auth_client_credential(user_id, oauth2_client_credential_id, **kwargs)

Delete Oauth token for the user

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • oauth2_client_credential_id (str) – (required) The ID of the Oauth credential.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_policy(policy_id, **kwargs)

Deletes the specified policy. The deletion takes effect typically within 10 seconds.

Parameters:
  • policy_id (str) – (required) The OCID of the policy.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_smtp_credential(user_id, smtp_credential_id, **kwargs)

Deletes the specified SMTP credential for the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • smtp_credential_id (str) – (required) The OCID of the SMTP credential.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_swift_password(user_id, swift_password_id, **kwargs)

Deprecated. Use :func:`delete_auth_token` instead.

Deletes the specified Swift password for the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • swift_password_id (str) – (required) The OCID of the Swift password.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_tag(tag_namespace_id, tag_name, **kwargs)

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 bulk_delete_tags() or the cascade_delete_tag_namespace() operation until this process completes.

To delete a tag, you must first retire it. Use update_tag() to retire a tag.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • tag_name (str) – (required) The name of the tag.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_tag_default(tag_default_id, **kwargs)

Deletes the the specified tag default.

Parameters:
  • tag_default_id (str) – (required) The OCID of the tag default.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_tag_namespace(tag_namespace_id, **kwargs)

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 cascade_delete_tag_namespace() to delete a tag namespace along with all of the tag definitions contained within that namespace.

Use delete_tag() to delete a tag definition.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_user(user_id, **kwargs)

Deletes the specified user. The user must not be in any groups.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

generate_totp_seed(user_id, mfa_totp_device_id, **kwargs)

Generate seed for the MFA TOTP device.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • mfa_totp_device_id (str) – (required) The OCID of the MFA TOTP device.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MfaTotpDevice

Return type:

Response

get_authentication_policy(compartment_id, **kwargs)

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

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AuthenticationPolicy

Return type:

Response

get_compartment(compartment_id, **kwargs)

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 list_instances() operation in the Cloud Compute Service or the list_volumes() operation in Cloud Block Storage.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Compartment

Return type:

Response

get_dynamic_group(dynamic_group_id, **kwargs)

Gets the specified dynamic group’s information.

Parameters:
  • dynamic_group_id (str) – (required) The OCID of the dynamic group.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DynamicGroup

Return type:

Response

get_group(group_id, **kwargs)

Gets the specified group’s information.

This operation does not return a list of all the users in the group. To do that, use list_user_group_memberships() and provide the group’s OCID as a query parameter in the request.

Parameters:
  • group_id (str) – (required) The OCID of the group.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Group

Return type:

Response

get_identity_provider(identity_provider_id, **kwargs)

Gets the specified identity provider’s information.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IdentityProvider

Return type:

Response

get_idp_group_mapping(identity_provider_id, mapping_id, **kwargs)

Gets the specified group mapping.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • mapping_id (str) – (required) The OCID of the group mapping.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IdpGroupMapping

Return type:

Response

get_mfa_totp_device(user_id, mfa_totp_device_id, **kwargs)

Get the specified MFA TOTP device for the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • mfa_totp_device_id (str) – (required) The OCID of the MFA TOTP device.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type MfaTotpDeviceSummary

Return type:

Response

get_network_source(network_source_id, **kwargs)

Gets the specified network source’s information.

Parameters:
  • network_source_id (str) – (required) The OCID of the network source.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkSources

Return type:

Response

get_policy(policy_id, **kwargs)

Gets the specified policy’s information.

Parameters:
  • policy_id (str) – (required) The OCID of the policy.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Policy

Return type:

Response

get_tag(tag_namespace_id, tag_name, **kwargs)

Gets the specified tag’s information.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • tag_name (str) – (required) The name of the tag.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Tag

Return type:

Response

get_tag_default(tag_default_id, **kwargs)

Retrieves the specified tag default.

Parameters:
  • tag_default_id (str) – (required) The OCID of the tag default.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TagDefault

Return type:

Response

get_tag_namespace(tag_namespace_id, **kwargs)

Gets the specified tag namespace’s information.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TagNamespace

Return type:

Response

get_tagging_work_request(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaggingWorkRequest

Return type:

Response

get_tenancy(tenancy_id, **kwargs)

Get the specified tenancy’s information.

Parameters:
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Tenancy

Return type:

Response

get_user(user_id, **kwargs)

Gets the specified user’s information.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type User

Return type:

Response

get_user_group_membership(user_group_membership_id, **kwargs)

Gets the specified UserGroupMembership’s information.

Parameters:
  • user_group_membership_id (str) – (required) The OCID of the userGroupMembership.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UserGroupMembership

Return type:

Response

get_user_ui_password_information(user_id, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UIPasswordInformation

Return type:

Response

get_work_request(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequest

Return type:

Response

list_api_keys(user_id, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ApiKey

Return type:

Response

list_auth_tokens(user_id, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AuthToken

Return type:

Response

list_availability_domains(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AvailabilityDomain

Return type:

Response

list_bulk_action_resource_types(bulk_action_type, **kwargs)

Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct resource-type information to the bulk_delete_resources() and bulk_move_resources() 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.

Parameters:
  • bulk_action_type (str) –

    (required) The type of bulk action.

    Allowed values are: “BULK_MOVE_RESOURCES”, “BULK_DELETE_RESOURCES”

  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BulkActionResourceTypeCollection

Return type:

Response

list_compartments(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • access_level (str) –

    (optional) Valid values are ANY and ACCESSIBLE. Default is ANY. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). For the compartments on which the user indirectly has INSPECT permissions, a restricted set of fields is returned.

    When set to ANY permissions are not checked.

    Allowed values are: “ANY”, “ACCESSIBLE”

  • compartment_id_in_subtree (bool) – (optional) Default is false. Can only be set to true when performing ListCompartments on the tenancy (root compartment). When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Compartment

Return type:

Response

list_cost_tracking_tags(compartment_id, **kwargs)

Lists all the tags enabled for cost-tracking in the specified tenancy. For information about cost-tracking tags, see Using Cost-tracking Tags.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Tag

Return type:

Response

list_customer_secret_keys(user_id, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CustomerSecretKeySummary

Return type:

Response

list_dynamic_groups(compartment_id, **kwargs)

Lists the dynamic groups in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DynamicGroup

Return type:

Response

list_fault_domains(compartment_id, availability_domain, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • availability_domain (str) – (required) The name of the availibilityDomain.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of FaultDomain

Return type:

Response

list_groups(compartment_id, **kwargs)

Lists the groups in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Group

Return type:

Response

list_identity_provider_groups(identity_provider_id, **kwargs)

Lists the identity provider groups.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of IdentityProviderGroupSummary

Return type:

Response

list_identity_providers(protocol, compartment_id, **kwargs)

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.

Parameters:
  • protocol (str) –

    (required) The protocol used for federation.

    Allowed values are: “SAML2”

  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of IdentityProvider

Return type:

Response

list_idp_group_mappings(identity_provider_id, **kwargs)

Lists the group mappings for the specified identity provider.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of IdpGroupMapping

Return type:

Response

list_mfa_totp_devices(user_id, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of MfaTotpDeviceSummary

Return type:

Response

list_network_sources(compartment_id, **kwargs)

Lists the network sources in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of NetworkSourcesSummary

Return type:

Response

list_o_auth_client_credentials(user_id, **kwargs)

List of Oauth tokens for the user

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of OAuth2ClientCredentialSummary

Return type:

Response

list_policies(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Policy

Return type:

Response

list_region_subscriptions(tenancy_id, **kwargs)

Lists the region subscriptions for the specified tenancy.

Parameters:
  • tenancy_id (str) – (required) The OCID of the tenancy.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of RegionSubscription

Return type:

Response

list_regions(**kwargs)

Lists all the regions offered by Oracle Cloud Infrastructure.

Parameters:retry_strategy (obj) –

(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:A Response object with data of type list of Region
Return type:Response
list_smtp_credentials(user_id, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SmtpCredentialSummary

Return type:

Response

list_swift_passwords(user_id, **kwargs)

Deprecated. Use :func:`list_auth_tokens` 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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SwiftPassword

Return type:

Response

list_tag_defaults(**kwargs)

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

Parameters:
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • id (str) – (optional) A filter to only return resources that match the specified OCID exactly.
  • compartment_id (str) – (optional) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • tag_definition_id (str) – (optional) The OCID of the tag definition.
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TagDefaultSummary

Return type:

Response

list_tag_namespaces(compartment_id, **kwargs)

Lists the tag namespaces in the specified compartment.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • include_subcompartments (bool) – (optional) An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TagNamespaceSummary

Return type:

Response

list_tagging_work_request_errors(work_request_id, **kwargs)

Gets the errors for a work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TaggingWorkRequestErrorSummary

Return type:

Response

list_tagging_work_request_logs(work_request_id, **kwargs)

Gets the logs for a work request.

Parameters:
  • work_request_id (str) – (required) The OCID of the work request.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TaggingWorkRequestLogSummary

Return type:

Response

list_tagging_work_requests(compartment_id, **kwargs)

Lists the tagging work requests in compartment.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • resource_identifier (str) – (optional) The identifier of the resource the work request affects.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TaggingWorkRequestSummary

Return type:

Response

list_tags(tag_namespace_id, **kwargs)

Lists the tag definitions in the specified tag namespace.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TagSummary

Return type:

Response

list_user_group_memberships(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • user_id (str) – (optional) The OCID of the user.
  • group_id (str) – (optional) The OCID of the group.
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of UserGroupMembership

Return type:

Response

list_users(compartment_id, **kwargs)

Lists the users in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • identity_provider_id (str) – (optional) The id of the identity provider.
  • external_identifier (str) – (optional) The id of a user in the identity provider.
  • name (str) – (optional) A filter to only return resources that match the given name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these “List” operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

    Allowed values are: “TIMECREATED”, “NAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of User

Return type:

Response

list_work_requests(compartment_id, **kwargs)

Lists the work requests in compartment.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment (remember that the tenancy is simply the root compartment).
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • limit (int) – (optional) The maximum number of items to return in a paginated “List” call.
  • resource_identifier (str) – (optional) The identifier of the resource the work request affects.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestSummary

Return type:

Response

move_compartment(compartment_id, move_compartment_details, **kwargs)

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.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • move_compartment_details (MoveCompartmentDetails) – (required) Request object for moving a compartment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

recover_compartment(compartment_id, **kwargs)

Recover the compartment from DELETED state to ACTIVE state.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Compartment

Return type:

Response

remove_user_from_group(user_group_membership_id, **kwargs)

Removes a user from a group by deleting the corresponding UserGroupMembership.

Parameters:
  • user_group_membership_id (str) – (required) The OCID of the userGroupMembership.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

reset_idp_scim_client(identity_provider_id, **kwargs)

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

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ScimClientCredentials

Return type:

Response

update_auth_token(user_id, auth_token_id, update_auth_token_details, **kwargs)

Updates the specified auth token’s description.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • auth_token_id (str) – (required) The OCID of the auth token.
  • update_auth_token_details (UpdateAuthTokenDetails) – (required) Request object for updating an auth token.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AuthToken

Return type:

Response

update_authentication_policy(compartment_id, update_authentication_policy_details, **kwargs)

Updates authentication policy for the specified tenancy

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • update_authentication_policy_details (UpdateAuthenticationPolicyDetails) – (required) Request object for updating the authentication policy.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AuthenticationPolicy

Return type:

Response

update_compartment(compartment_id, update_compartment_details, **kwargs)

Updates the specified compartment’s description or name. You can’t update the root compartment.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • update_compartment_details (UpdateCompartmentDetails) – (required) Request object for updating a compartment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Compartment

Return type:

Response

update_customer_secret_key(user_id, customer_secret_key_id, update_customer_secret_key_details, **kwargs)

Updates the specified secret key’s description.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • customer_secret_key_id (str) – (required) The OCID of the secret key.
  • update_customer_secret_key_details (UpdateCustomerSecretKeyDetails) – (required) Request object for updating a secret key.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CustomerSecretKeySummary

Return type:

Response

update_dynamic_group(dynamic_group_id, update_dynamic_group_details, **kwargs)

Updates the specified dynamic group.

Parameters:
  • dynamic_group_id (str) – (required) The OCID of the dynamic group.
  • update_dynamic_group_details (UpdateDynamicGroupDetails) – (required) Request object for updating an dynamic group.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DynamicGroup

Return type:

Response

update_group(group_id, update_group_details, **kwargs)

Updates the specified group.

Parameters:
  • group_id (str) – (required) The OCID of the group.
  • update_group_details (UpdateGroupDetails) – (required) Request object for updating a group.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Group

Return type:

Response

update_identity_provider(identity_provider_id, update_identity_provider_details, **kwargs)

Updates the specified identity provider.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • update_identity_provider_details (UpdateIdentityProviderDetails) – (required) Request object for updating a identity provider.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IdentityProvider

Return type:

Response

update_idp_group_mapping(identity_provider_id, mapping_id, update_idp_group_mapping_details, **kwargs)

Updates the specified group mapping.

Parameters:
  • identity_provider_id (str) – (required) The OCID of the identity provider.
  • mapping_id (str) – (required) The OCID of the group mapping.
  • update_idp_group_mapping_details (UpdateIdpGroupMappingDetails) – (required) Request object for updating an identity provider group mapping
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IdpGroupMapping

Return type:

Response

update_network_source(network_source_id, update_network_source_details, **kwargs)

Updates the specified network source.

Parameters:
  • network_source_id (str) – (required) The OCID of the network source.
  • update_network_source_details (UpdateNetworkSourceDetails) – (required) Request object for updating a network source.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkSources

Return type:

Response

update_o_auth_client_credential(user_id, oauth2_client_credential_id, update_o_auth2_client_credential_details, **kwargs)

Updates Oauth token for the user

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • oauth2_client_credential_id (str) – (required) The ID of the Oauth credential.
  • update_o_auth2_client_credential_details (UpdateOAuth2ClientCredentialDetails) – (required) Request object containing the information required to generate an Oauth token.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type OAuth2ClientCredential

Return type:

Response

update_policy(policy_id, update_policy_details, **kwargs)

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

Policy changes take effect typically within 10 seconds.

Parameters:
  • policy_id (str) – (required) The OCID of the policy.
  • update_policy_details (UpdatePolicyDetails) – (required) Request object for updating a policy.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Policy

Return type:

Response

update_smtp_credential(user_id, smtp_credential_id, update_smtp_credential_details, **kwargs)

Updates the specified SMTP credential’s description.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • smtp_credential_id (str) – (required) The OCID of the SMTP credential.
  • update_smtp_credential_details (UpdateSmtpCredentialDetails) – (required) Request object for updating a SMTP credential.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SmtpCredentialSummary

Return type:

Response

update_swift_password(user_id, swift_password_id, update_swift_password_details, **kwargs)

Deprecated. Use :func:`update_auth_token` instead.

Updates the specified Swift password’s description.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • swift_password_id (str) – (required) The OCID of the Swift password.
  • update_swift_password_details (UpdateSwiftPasswordDetails) – (required) Request object for updating a Swift password.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SwiftPassword

Return type:

Response

update_tag(tag_namespace_id, tag_name, update_tag_details, **kwargs)

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.

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • tag_name (str) – (required) The name of the tag.
  • update_tag_details (UpdateTagDetails) – (required) Request object for updating a tag.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Tag

Return type:

Response

update_tag_default(tag_default_id, update_tag_default_details, **kwargs)

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.
Parameters:
  • tag_default_id (str) – (required) The OCID of the tag default.
  • update_tag_default_details (UpdateTagDefaultDetails) – (required) Request object for updating a tag default.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TagDefault

Return type:

Response

update_tag_namespace(tag_namespace_id, update_tag_namespace_details, **kwargs)

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 update_tag(). For more information about retiring tag namespaces, see Retiring Key Definitions and Namespace Definitions.

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

Parameters:
  • tag_namespace_id (str) – (required) The OCID of the tag namespace.
  • update_tag_namespace_details (UpdateTagNamespaceDetails) – (required) Request object for updating a namespace.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TagNamespace

Return type:

Response

update_user(user_id, update_user_details, **kwargs)

Updates the description of the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • update_user_details (UpdateUserDetails) – (required) Request object for updating a user.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type User

Return type:

Response

update_user_capabilities(user_id, update_user_capabilities_details, **kwargs)

Updates the capabilities of the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • update_user_capabilities_details (UpdateUserCapabilitiesDetails) – (required) Request object for updating user capabilities.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type User

Return type:

Response

update_user_state(user_id, update_state_details, **kwargs)

Updates the state of the specified user.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • update_state_details (UpdateStateDetails) – (required) Request object for updating a user state.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type User

Return type:

Response

upload_api_key(user_id, create_api_key_details, **kwargs)

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.

Parameters:
  • user_id (str) – (required) The OCID of the user.
  • create_api_key_details (CreateApiKeyDetails) – (required) Request object for uploading an API key for a user.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ApiKey

Return type:

Response