Skip to main content
Version: v2

ISensitivityLabel Interface

A single sensitivity label applied to a document, part of the socket storage discovery response.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface ISensitivityLabel

Properties​

PropertyAlertsTypeDescription
appliedByUserEmailBetastringEmail of the user who applied the label.
assignmentMethodBetastringHow the label was assigned, for example "standard".
sensitivityLabelIdBetastringUnique identifier of the sensitivity label.
tenantIdBetastringTenant under which the label is defined.

Property Details​

appliedByUserEmail​

Email of the user who applied the label.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

appliedByUserEmail: string;

Type: string

assignmentMethod​

How the label was assigned, for example "standard".

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

assignmentMethod: string;

Type: string

sensitivityLabelId​

Unique identifier of the sensitivity label.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

sensitivityLabelId: string;

Type: string

tenantId​

Tenant under which the label is defined.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

tenantId: string;

Type: string