UserPrincipal (Cyclos 4.16.19 Scripting API Documentation)

All Known Subinterfaces:

DelegatingMutableUserPrincipal, DelegatingUserPrincipal, IUserAccount, SessionData

All Known Implementing Classes:

AbstractSessionData, AccessClient, AccessClientSessionData, CustomWizardExecution, DirectUserSessionData, ExternalRedirectExecution, GuestSessionData, LocateUserResult, MobilePhone, NFCToken, OidcAuthorization, OidcSessionData, PendingUserAccount, Pin, ScriptSessionData, Session, StatefulUserSessionData, StatelessUserSessionData, SystemSessionData, Token, TrustedDevice, UserAccount, UserCustomFieldValue, UserIdentityProvider, UserPrincipals.SimpleUserPrincipal, UserSessionData
```
public interface UserPrincipal
```
A principal that identifies a user

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AccessClient`	`getAccessClient()`
`UserAccountType`	`getAccountType()`
`BasicUser`	`getBasicUser()`
`UserCustomFieldValue`	`getCustomFieldValue()`
`MobilePhone`	`getMobilePhone()`
`String`	`getPrincipal()`	Should return a value that can be used to identify the user.
`PrincipalType`	`getPrincipalType()`
`Token`	`getToken()`
`TrustedDevice`	`getTrustedDevice()`

Method Detail

getAccessClient
```
AccessClient getAccessClient()
```

getAccountType
```
UserAccountType getAccountType()
```

getBasicUser
```
BasicUser getBasicUser()
```

getCustomFieldValue

UserCustomFieldValue getCustomFieldValue()

getMobilePhone
```
MobilePhone getMobilePhone()
```

getPrincipal
```
String getPrincipal()
```
Should return a value that can be used to identify the user. In case the value should be hidden, implementors should return null.

getPrincipalType
```
PrincipalType getPrincipalType()
```

getToken
```
Token getToken()
```

getTrustedDevice
```
TrustedDevice getTrustedDevice()
```