Skip to content
  • Auto
  • Light
  • Dark
Get Started

Attributes

Attributes

Attributes

Create Attribute Value
client.attributes.create(AttributeCreateParamsbody?, RequestOptionsoptions?): valueAttributeValueAttributeCreateResponse
post/api/v1/attributes
Get Attribute Value
client.attributes.retrieve(stringid, RequestOptionsoptions?): valueAttributeValueAttributeRetrieveResponse
get/api/v1/attributes/{id}
Delete Attribute Value
client.attributes.delete(stringid, AttributeDeleteParamsparams?, RequestOptionsoptions?): AttributeDeleteResponse
delete/api/v1/attribute/{id}
Attribute Value
AttributeValue

AttributeValue is the value of an attribute of a defined type.

ShowShow
idstring
optional

The ID of the AttributeValue.

attributeTypeIdstring
optional

The ID of the AttributeType that this AttributeValue belongs to.

createdAtstring
optional
formatdate-time
deletedAtstring
optional
formatdate-time
updatedAtstring
optional
formatdate-time
valuestring
optional

The value of the AttributeValue. This is the string that will be displayed to the user.

AttributesCompliance Frameworks

Create Compliance Framework Attribute Value
client.attributes.complianceFrameworks.create(ComplianceFrameworkCreateParamsbody?, RequestOptionsoptions?): valueAttributeValueComplianceFrameworkCreateResponse
post/api/v1/attributes/compliance_frameworks
Get Compliance Framework Attribute Value
client.attributes.complianceFrameworks.retrieve(stringid, RequestOptionsoptions?): valueAttributeValueComplianceFrameworkRetrieveResponse
get/api/v1/attributes/compliance_frameworks/{id}
Delete Compliance Framework Attribute Value
client.attributes.complianceFrameworks.delete(stringid, ComplianceFrameworkDeleteParamsparams?, RequestOptionsoptions?): ComplianceFrameworkDeleteResponse
delete/api/v1/attributes/compliance_frameworks/{id}

AttributesRisk Levels

Create Risk Level Attribute Value
client.attributes.riskLevels.create(RiskLevelCreateParamsbody?, RequestOptionsoptions?): valueAttributeValueRiskLevelCreateResponse
post/api/v1/attributes/risk_levels
Get Risk Level Attribute Value
client.attributes.riskLevels.retrieve(stringid, RequestOptionsoptions?): valueAttributeValueRiskLevelRetrieveResponse
get/api/v1/attributes/risk_levels/{id}
Delete Risk Level Attribute Value
client.attributes.riskLevels.delete(stringid, RiskLevelDeleteParamsparams?, RequestOptionsoptions?): RiskLevelDeleteResponse
delete/api/v1/attributes/risk_levels/{id}

AttributesTypes

List Attribute Types
client.attributes.types.list(TypeListParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringTypeListResponse
get/api/v1/attributes/types
List Attribute Values
client.attributes.types.listValues(stringattributeTypeID, TypeListValuesParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringTypeListValuesResponse
get/api/v1/attributes/types/{attribute_type_id}/values