Edit

Excel.SensitivityLabelAbacAttributeValue interface

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 a single selectable value of an attribute-based access control (ABAC) attribute that can be applied to a sensitivity label.

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

Used by

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/98-preview-apis/manage-sensitivity-labels.yaml

// Get available ABAC attributes and describe the kind of value each attribute accepts.
const container = document.getElementById("abac-attributes");
while (container.firstChild) {
    container.removeChild(container.firstChild);
}
await Excel.run(async (context) => {
    const labelCatalog: Excel.SensitivityLabelsCatalog = context.sensitivityLabelsCatalog;
    if (!labelCatalog) {
        console.warn("The sensitivity label catalog isn't available in this version of Excel.");
        return;
    }

    labelCatalog.load("getLabelingCapabilities");
    await context.sync();

    const capabilities: Excel.LabelingCapability[] = labelCatalog.getLabelingCapabilities;
    if (capabilities.indexOf(Excel.LabelingCapability.attributeBasedAccessControlEnabled) === -1) {
        console.warn("ABAC attributes aren't enabled or available for the current user.");
        return;
    }

    const catalogAttributes: OfficeExtension.ClientResult<Excel.SensitivityLabelAbacAttribute[]> =
        labelCatalog.getAttributes();
    await context.sync();

    if (catalogAttributes.value.length === 0) {
        console.log("No ABAC attributes are available in the sensitivity label catalog.");
        return;
    }

    console.log("Available ABAC attributes:");
    catalogAttributes.value.forEach((attribute: Excel.SensitivityLabelAbacAttribute) => {
        let dataTypeDescription: string;
        switch (attribute.dataType) {
            case Excel.SensitivityLabelAbacAttributeDataType.booleanValue:
                dataTypeDescription = "Boolean";
                break;
            case Excel.SensitivityLabelAbacAttributeDataType.dateValue:
                dataTypeDescription = "Date";
                break;
            case Excel.SensitivityLabelAbacAttributeDataType.numberValue:
                dataTypeDescription = "Number";
                break;
            case Excel.SensitivityLabelAbacAttributeDataType.stringValue:
                dataTypeDescription = "String";
                break;
            case Excel.SensitivityLabelAbacAttributeDataType.unknown:
                dataTypeDescription = "Unknown";
                break;
            default:
                dataTypeDescription = `Unrecognized (${attribute.dataType})`;
                break;
        }

        console.log(`ABAC attribute: ${attribute.displayName}`, {
            dataType: attribute.dataType,
            dataTypeDescription,
            displayOrder: attribute.displayOrder,
            isActive: attribute.isActive,
            isMultiValued: attribute.isMultiValued,
            values: attribute.values.map((attributeValue: Excel.SensitivityLabelAbacAttributeValue) => ({
                displayName: attributeValue.displayName,
                displayOrder: attributeValue.displayOrder,
                id: attributeValue.id,
                isActive: attributeValue.isActive
            }))
        });
    });

    addAttributeOptions(catalogAttributes.value);
});

Properties

displayName

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

displayOrder

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

id

Gets the unique identifier of the ABAC attribute value. This identifier is used when applying or updating the label's ABAC attribute selections.

isActive

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

Property Details

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 value. 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 value within its attribute when displayed to a user.

displayOrder: number;

Property Value

number

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)

id

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 unique identifier of the ABAC attribute value. This identifier is used when applying or updating the label's ABAC attribute selections.

id: string;

Property Value

string

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 value is active. true if the value is active; otherwise, false.

isActive: boolean;

Property Value

boolean

Remarks

API set: ExcelApi BETA (PREVIEW ONLY)