# Uses of Interface
com.sas.services.user.UserIdentityInterface

Packages that use UserIdentityInterface
Package
Description
com.sas.services.connection.platform
Provides a connection factory configuation for use with SAS Foundation Services.
com.sas.services.information
Interact with data repositories on behalf of client applications.
com.sas.services.security
Perform Authentication against modular authentication providers with user identities.
com.sas.services.user
Maintain user identities and profiles.
com.sas.services.webapp

- ## Uses of UserIdentityInterface in com.sas.services.connection.platform

  Methods in com.sas.services.connection.platform that return UserIdentityInterface
  Modifier and Type
  Method
  Description
  `UserIdentityInterface`
  PlatformPasswordCredential.`getUserIdentity()`
  Get the user identity.
  Constructors in com.sas.services.connection.platform with parameters of type UserIdentityInterface
  Modifier
  Constructor
  Description
  `protected`
  `PlatformPasswordCredential(String userName, String password, String domain, UserContextInterface userContext, UserIdentityInterface userIdentity, List factoryDomainList)`

- ## Uses of UserIdentityInterface in com.sas.services.information

  Methods in com.sas.services.information that return UserIdentityInterface
  Modifier and Type
  Method
  Description
  `UserIdentityInterface`
  OMIServer.`generatePassword(String user)`
  `UserIdentityInterface`
  ServerInterface.`generatePassword(String user)`
  Generate a one-time use password against the metadata server connection for the specified user.

- ## Uses of UserIdentityInterface in com.sas.services.security

  Methods in com.sas.services.security with parameters of type UserIdentityInterface
  Modifier and Type
  Method
  Description
  `boolean`
  Authenticator.`authenticate(UserContextInterface user, UserIdentityInterface ident, Map options)`
  Authenticates a user identity.
  `boolean`
  AuthenticatorInterface.`authenticate(UserContextInterface user, UserIdentityInterface identity, Map options)`
  Authenticates a user identity.
  `void`
  LoginCallbackHandler.`setIdentity(UserIdentityInterface ident)`
  Sets the user's identity.
  Constructors in com.sas.services.security with parameters of type UserIdentityInterface
  Modifier
  Constructor
  Description
  ``
  `LoginCallbackHandler(UserContextInterface user, UserIdentityInterface ident, Map options)`
  Constructs a login callback handler for the specified user context, identity, and options.

- ## Uses of UserIdentityInterface in com.sas.services.user

  Classes in com.sas.services.user that implement UserIdentityInterface
  Modifier and Type
  Class
  Description
  `class`
  `SimpleUserIdentity`
  The SimpleUserIdentity class implements a simple user/password identity.
  Methods in com.sas.services.user that return UserIdentityInterface
  Modifier and Type
  Method
  Description
  `UserIdentityInterface`
  UserContext.`getIdentityByDomain(String domain)`
  Get an identity by domain.
  `UserIdentityInterface`
  UserContext.`getIdentityByDomain(String domain, boolean issueChallenge)`
  Get an identity by domain.
  `UserIdentityInterface`
  UserContext.`getIdentityByDomain(String domain, boolean issueChallenge, String prompt)`
  Gets a user identify by domain.
  `UserIdentityInterface`
  UserContextInterface.`getIdentityByDomain(String domain)`
  Get an authentication identity for the given domain.
  `UserIdentityInterface`
  UserContextInterface.`getIdentityByDomain(String domain, boolean issueChallenge)`
  Get an identity by domain.
  `UserIdentityInterface`
  UserContextInterface.`getIdentityByDomain(String domain, boolean issueChallenge, String challengePrompt)`
  Get an identity by domain.
  `UserIdentityInterface`
  UserService.`newUserIdentity(Object principal, Object credential, String domain, String mechanism)`
  Return a new user identity object given the Pricipal, credential, domain, and authentication mechanism.
  `UserIdentityInterface`
  UserServiceInterface.`newUserIdentity(Object principal, Object credential, String domain, String mechanism)`
  Return a new user identity object given the Pricipal, credential, domain, and authentication mechanism.
  `UserIdentityInterface`
  UserServiceProxy.`newUserIdentity(Object principal, Object credential, String domain, String mechanism)`
  Return a new user identity object given the Pricipal, credential, domain, and authentication mechanism.
  Methods in com.sas.services.user that return types with arguments of type UserIdentityInterface
  Modifier and Type
  Method
  Description
  `List<UserIdentityInterface>`
  IdentityChangeEvent.`getIdentities()`
  Methods in com.sas.services.user with parameters of type UserIdentityInterface
  Modifier and Type
  Method
  Description
  `void`
  UserContext.`addIdentity(UserIdentityInterface identity)`
  Adds a new authentication identity to this user context.
  `void`
  UserContextInterface.`addIdentity(UserIdentityInterface identity)`
  Add an identity to the context.
  `boolean`
  UserContext.`authenticate(UserIdentityInterface ident, Map options)`
  Authenticates a user identity.
  `boolean`
  UserContextInterface.`authenticate(UserIdentityInterface ident, Map options)`
  Authenticates a user identity.
  `void`
  UserContext.`removeIdentity(UserIdentityInterface identity)`
  Remove an identity from the context.
  `void`
  UserContextInterface.`removeIdentity(UserIdentityInterface identity)`
  Remove an identity from the context.
  Constructor parameters in com.sas.services.user with type arguments of type UserIdentityInterface
  Modifier
  Constructor
  Description
  ``
  `IdentityChangeEvent(List<UserIdentityInterface> identities, IdentityChangeEvent.Type type)`

- ## Uses of UserIdentityInterface in com.sas.services.webapp

  Methods in com.sas.services.webapp that return UserIdentityInterface
  Modifier and Type
  Method
  Description
  `UserIdentityInterface`
  SessionHelper.`getSuccessfulCredential()`
  Return the possibly null credential (UserIdentityInterface) used to authenticate the session.