Package com.coveo.pushapiclient

Class SecurityIdentity

java.lang.Object

com.coveo.pushapiclient.SecurityIdentity

public class SecurityIdentity
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	identity	The name of the security identity.
SecurityIdentityType	identityType	The type of the identity.
String	securityProvider	The security identity provider through which the security identity is updated.

Constructor Summary

Constructors

Constructor	Description
SecurityIdentity(String identity, SecurityIdentityType securityIdentityType, String securityProvider)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

identity

public String identity

The name of the security identity.

Examples: - `asmith@example.com` - `SampleTeam2`

identityType

public SecurityIdentityType identityType

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`.

securityProvider

public String securityProvider

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

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

Constructor Details

SecurityIdentity

public SecurityIdentity(String identity,
 SecurityIdentityType securityIdentityType,
 String securityProvider)