Excel.SensitivityLabelAbacAttribute interface

Package:

excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents an attribute-based access control (ABAC) attribute available for selection on an ABAC-enabled sensitivity label.

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

Used by

• Excel.SensitivityLabelTryUpdateOptions: abacAttributes
• Excel.SensitivityLabelsCatalog: getAttributes

Properties

dataType	Gets the data type of the ABAC attribute.
displayName	Gets the display name of the ABAC attribute. Add-ins are responsible for presenting localized user-facing UI.
displayOrder	Gets the recommended ordering of this ABAC attribute when displayed to a user.
isActive	Gets whether this ABAC attribute is active. true if the attribute is active; otherwise, false.
isMultiValued	Gets whether more than one value can be selected for this ABAC attribute. true if multi-select; otherwise, false.
values	Gets the values that are selectable for this ABAC attribute.

Property Details

dataType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the data type of the ABAC attribute.

dataType: Excel.SensitivityLabelAbacAttributeDataType | "Unknown" | "StringValue" | "BooleanValue" | "NumberValue" | "DateValue";

Property Value

Excel.SensitivityLabelAbacAttributeDataType | "Unknown" | "StringValue" | "BooleanValue" | "NumberValue" | "DateValue"

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

displayName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the display name of the ABAC attribute. Add-ins are responsible for presenting localized user-facing UI.

displayName: string;

Property Value

string

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

displayOrder

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the recommended ordering of this ABAC attribute when displayed to a user.

displayOrder: number;

Property Value

number

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

isActive

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets whether this ABAC attribute is active. true if the attribute is active; otherwise, false.

isActive: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

isMultiValued

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets whether more than one value can be selected for this ABAC attribute. true if multi-select; otherwise, false.

isMultiValued: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

values

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the values that are selectable for this ABAC attribute.

values: SensitivityLabelAbacAttributeValue[];

Property Value

Excel.SensitivityLabelAbacAttributeValue[]

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)