Show / Hide Table of Contents

Class SecurityAttribute

A security attribute that belongs to a specific security attribute namespace. Security attributes must be created in a tenancy before a user can apply them to resources. For more information, see Managing Security Attributes.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance
object
SecurityAttribute
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.SecurityattributeService.Models
Assembly: OCI.DotNetSDK.Securityattribute.dll
Syntax
public class SecurityAttribute

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains the security attribute definition.

Remarks

Required

Description

Declaration
[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

The description of the security attribute.

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the security attribute definition.

Remarks

Required

IsRetired

Declaration
[Required(ErrorMessage = "IsRetired is required.")]
[JsonProperty(PropertyName = "isRetired")]
public bool? IsRetired { get; set; }
Property Value
Type Description
bool?

Indicates whether the security attribute is retired. See Managing Security Attribute Namespaces.

Remarks

Required

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityAttribute.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
SecurityAttribute.LifecycleStateEnum?

The security attribute's current state. After creating a security attribute, make sure its lifecycleState is ACTIVE before using it. After retiring a security attribute, make sure its lifecycleState is INACTIVE before using it. If you delete a security attribute, you cannot delete another security attribute until the deleted tag's lifecycleState changes from DELETING to DELETED.

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

The name assigned to the security attribute during creation. This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed.

Remarks

Required

SecurityAttributeNamespaceId

Declaration
[Required(ErrorMessage = "SecurityAttributeNamespaceId is required.")]
[JsonProperty(PropertyName = "securityAttributeNamespaceId")]
public string SecurityAttributeNamespaceId { get; set; }
Property Value
Type Description
string

The OCID of the security attribute namespace that contains the security attribute definition.

Remarks

Required

SecurityAttributeNamespaceName

Declaration
[Required(ErrorMessage = "SecurityAttributeNamespaceName is required.")]
[JsonProperty(PropertyName = "securityAttributeNamespaceName")]
public string SecurityAttributeNamespaceName { get; set; }
Property Value
Type Description
string

The name of the security attribute namespace that contains the security attribute.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

Date and time the security attribute was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z

Remarks

Required

Type

Declaration
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type Description
string

The data type of the security attribute.

Validator

Declaration
[JsonProperty(PropertyName = "validator")]
public BaseSecurityAttributeValidator Validator { get; set; }
Property Value
Type Description
BaseSecurityAttributeValidator
In this article
Back to top