SecurityAttributeClient¶

class oci.security_attribute.SecurityAttributeClient(config, **kwargs)¶

Use the Security Attributes API to manage security attributes and security attribute namespaces. For more information, see the documentation for [Security Attributes](/iaas/Content/zero-trust-packet-routing/managing-security-attributes.htm) and [Security Attribute Nampespaces](/iaas/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`bulk_delete_security_attributes`(…)	Deletes the specified security attribute definitions.
`bulk_edit_security_attributes`(**kwargs)	Edits the specified list of security attributes for the selected resources.
`cascading_delete_security_attribute_namespace`(…)	Deletes the specified security attribute namespace.
`change_security_attribute_namespace_compartment`(…)	Moves the specified security attribute namespace to the specified compartment within the same tenancy.
`create_security_attribute`(…)	Creates a new security attribute in the specified security attribute namespace.
`create_security_attribute_namespace`(…)	Creates a new security attribute namespace in the specified compartment.
`delete_security_attribute`(…)	Deletes the specified security attribute.
`delete_security_attribute_namespace`(…)	Deletes the specified security attribute namespace.
`get_security_attribute`(…)	Gets the specified security attribute’s information.
`get_security_attribute_namespace`(…)	Gets the specified security attribute namespace’s information.
`get_security_attribute_work_request`(…)	Gets details on a specified work request.
`list_security_attribute_namespaces`(**kwargs)	Lists the security attribute namespaces in the specified compartment.
`list_security_attribute_work_request_errors`(…)	Gets the errors for a work request.
`list_security_attribute_work_request_logs`(…)	Gets the logs for a work request.
`list_security_attribute_work_requests`(**kwargs)	Lists the security attribute work requests in compartment.
`list_security_attributes`(…)	Lists the security attributes in the specified namespace.
`update_security_attribute`(…)	Updates the specified security attribute.
`update_security_attribute_namespace`(…)	Updates the specified security attribute namespace.

__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.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

bulk_delete_security_attributes(bulk_delete_security_attributes_details, **kwargs)¶

Deletes the specified security attribute definitions. This operation triggers a process that removes the security attributes from all resources in your tenancy. The security attributes must be within the same security attribute namespace.

The following actions happen immediately:

After you start this operation, the state of the tag changes to DELETING, and security attribute 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 security attributes have been removed, the state changes to DELETED. You cannot restore a deleted security attribute. After the security attribute state changes to DELETED, you can use the same security attribute name again.

After you start this operation, you cannot start either the delete_security_attribute() or the cascade_delete_security_attribute_namespace() operation until this process completes.

In order to delete security attribute, you must first retire the security attribute. Use update_security_attribute() to retire a security attribute.

Parameters:	bulk_delete_security_attributes_details (oci.security_attribute.models.BulkDeleteSecurityAttributesDetails) – (required) Request object for deleting security attributes 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use bulk_delete_security_attributes API.

bulk_edit_security_attributes(**kwargs)¶

Edits the specified list of security attributes for the selected resources. This operation triggers a process that edits the attributes on all selected resources. The possible actions are:

Add a security attribute when it does not already exist on the resource.

Update the value for a security attribute when it is present on the resource.

Add a security attribute when it does not already exist on the resource or update the value when it is present on the resource.

Remove a security attribute from a resource. The security attribute is removed from the resource regardless of the value.

The edits can include a combination of operations and attributes. However, multiple operations cannot apply to the same attribute in the same request.

Parameters:	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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. bulk_edit_security_attribute_details (oci.security_attribute.models.BulkEditSecurityAttributeDetails) – (optional) The request object for bulk editing security attributes on resources in 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use bulk_edit_security_attributes API.

cascading_delete_security_attribute_namespace(security_attribute_namespace_id, **kwargs)¶

Deletes the specified security attribute namespace. This operation triggers a process that removes all of the security attributes defined in the specified security attribute namespace from all resources in your tenancy and then deletes the security attribute namespace.

After you start the delete operation:

New security attribute key definitions cannot be created under the namespace.

The state of the security attribute namespace changes to DELETING.

Security attribute removal from the resources begins.

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

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

After you start this operation, you cannot start either the delete_security_attribute() or the bulk_delete_security_attributes() operation until this process completes.

To delete a security attribute namespace, you must first retire it. Use update_security_attribute_namespace() to retire a security attribute namespace.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use cascading_delete_security_attribute_namespace API.

change_security_attribute_namespace_compartment(security_attribute_namespace_id, change_security_attribute_namespace_compartment_details, **kwargs)¶

Moves the specified security attribute namespace to the specified compartment within the same tenancy.

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

Moving a security attribute namespace moves all the security attributes contained in the security attribute namespace.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. change_security_attribute_namespace_compartment_details (oci.security_attribute.models.ChangeSecurityAttributeNamespaceCompartmentDetails) – (required) Request object for changing the compartment of a security attribute 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_security_attribute_namespace_compartment API.

create_security_attribute(security_attribute_namespace_id, create_security_attribute_details, **kwargs)¶

Creates a new security attribute in the specified security attribute namespace.

The security attribute requires either the OCID or the name of the security attribute namespace that will contain this security attribute.

You must specify a name for the attribute, which must be unique across all attributes in the security attribute namespace and cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, “mySecurityAttribute” and “mysecurityattribute” are not allowed in the same namespace. If you specify a name that’s already in use in the security attribute namespace, a 409 error is returned.

The security attribute must have a description. It does not have to be unique, and you can change it with update_security_attribute().

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

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. create_security_attribute_details (oci.security_attribute.models.CreateSecurityAttributeDetails) – (required) Request object for creating a new security attribute in the specified security attribute namespace. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttribute`
Return type:	`Response`
Example:

Click here to see an example of how to use create_security_attribute API.

create_security_attribute_namespace(create_security_attribute_namespace_details, **kwargs)¶

Creates a new security attribute 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 only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. 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 security_attribute_namespace().

Parameters:	create_security_attribute_namespace_details (oci.security_attribute.models.CreateSecurityAttributeNamespaceDetails) – (required) Request object for creating a new security attribute 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttributeNamespace`
Return type:	`Response`
Example:

Click here to see an example of how to use create_security_attribute_namespace API.

delete_security_attribute(security_attribute_namespace_id, security_attribute_name, **kwargs)¶

Deletes the specified security attribute. This operation triggers a process that removes the security attribute from all resources in your tenancy.

When you start the delete operation, the state of the security attribute changes to DELETING and security attribute 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 attributes have been removed, the state changes to DELETED. You cannot restore a deleted attribute. Once the deleted attribute changes its state to DELETED, you can use the same security attribute name again.

After you start this operation, you cannot start either the bulk_delete_security_attributes() or the cascade_delete_tag_namespace() operation until this process completes.

To delete a security attribute, you must first retire it. Use update_security_attribute() to retire a security attribute.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. security_attribute_name (str) – (required) The name of the security attribute. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_security_attribute API.

delete_security_attribute_namespace(security_attribute_namespace_id, **kwargs)¶

Deletes the specified security attribute namespace. Only an empty security attribute namespace can be deleted with this operation. To use this operation to delete a security attribute namespace that contains security attributes, first delete all of its security attributes. Use delete_security_attribute() to delete a security attribute.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_security_attribute_namespace API.

get_security_attribute(security_attribute_namespace_id, security_attribute_name, **kwargs)¶

Gets the specified security attribute’s information.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. security_attribute_name (str) – (required) The name of the security attribute. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttribute`
Return type:	`Response`
Example:

Click here to see an example of how to use get_security_attribute API.

get_security_attribute_namespace(security_attribute_namespace_id, **kwargs)¶

Gets the specified security attribute namespace’s information.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttributeNamespace`
Return type:	`Response`
Example:

Click here to see an example of how to use get_security_attribute_namespace API.

get_security_attribute_work_request(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The OCID of the work request. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttributeWorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_security_attribute_work_request API.

list_security_attribute_namespaces(**kwargs)¶

Lists the security attribute namespaces in the specified compartment.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list 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. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are: “ASC”, “DESC” 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” name (str) – (optional) A filter to return only resources that match the entire display name given. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. compartment_id_in_subtree (bool) – (optional) An optional boolean parameter indicating whether to retrieve all security attribute namespaces in subcompartments. If this parameter is not specified, only the 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SecurityAttributeNamespaceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_security_attribute_namespaces API.

list_security_attribute_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. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SecurityAttributeWorkRequestErrorSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_security_attribute_work_request_errors API.

list_security_attribute_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. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SecurityAttributeWorkRequestLogSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_security_attribute_work_request_logs API.

list_security_attribute_work_requests(**kwargs)¶

Lists the security attribute work requests in compartment.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list 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. resource_identifier (str) – (optional) The identifier of the resource the work request affects. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SecurityAttributeWorkRequestSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_security_attribute_work_requests API.

list_security_attributes(security_attribute_namespace_id, **kwargs)¶

Lists the security attributes in the specified namespace.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute 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. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SecurityAttributeSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_security_attributes API.

update_security_attribute(security_attribute_namespace_id, security_attribute_name, update_security_attribute_details, **kwargs)¶

Updates the specified security attribute. You can only update description, and isRetired.

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. security_attribute_name (str) – (required) The name of the security attribute. update_security_attribute_details (oci.security_attribute.models.UpdateSecurityAttributeDetails) – (required) Request object for updating a security attribute. 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttribute`
Return type:	`Response`
Example:

Click here to see an example of how to use update_security_attribute API.

update_security_attribute_namespace(security_attribute_namespace_id, update_security_attribute_namespace_details, **kwargs)¶

Updates the specified security attribute namespace. You can’t update the namespace name.

Updating isRetired to ‘true’ retires the namespace and all the security attributes in the namespace. Reactivating a namespace (changing isRetired from ‘true’ to ‘false’) does not reactivate security attributes. To reactivate the security attributes, you must reactivate each one individually after you reactivate the namespace, using update_tag(). For more information about retiring security attribute namespaces, see Managing Security Attribute Namespaces.

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

Parameters:	security_attribute_namespace_id (str) – (required) The OCID of the security attribute namespace. update_security_attribute_namespace_details (oci.security_attribute.models.UpdateSecurityAttributeNamespaceDetails) – (required) Request object for updating a 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. The only valid characters for request IDs are letters, numbers, underscore, and dash. 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 running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might 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. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SecurityAttributeNamespace`
Return type:	`Response`
Example:

Click here to see an example of how to use update_security_attribute_namespace API.