Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SecurityIdentity

A security identity. See https://docs.coveo.com/en/1719 for more information.

Hierarchy

  • SecurityIdentity

Index

Properties

identity

identity: string

The name of the security identity.

Examples:

  • asmith@example.com
  • SampleTeam2

identityType

identityType: SecurityIdentityType

The type of the identity. Valid values:

  • UNKNOWN
  • USER : Defines a single user.
  • GROUP : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).
  • VIRTUAL_GROUP : Defines a group that doesn't exist within the indexed system. Mechanically, a VIRTUAL_GROUP is identical to a GROUP.

Optional securityProvider

securityProvider: string

The security identity provider through which the security identity is updated.

Defaults to the first security identity provider associated with the target Push source.

Generated using TypeDoc