***
title: "UserService"
generated: true
---------------
Contains methods relating to [User](/current/core/reference/typescript-api/entities/user#user) entities.
```ts title="Signature"
class UserService {
constructor(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, passwordCipher: PasswordCipher, verificationTokenGenerator: VerificationTokenGenerator, moduleRef: ModuleRef)
getUserById(ctx: RequestContext, userId: ID) => Promise;
getUserByEmailAddress(ctx: RequestContext, emailAddress: string, userType?: 'administrator' | 'customer') => Promise;
createCustomerUser(ctx: RequestContext, identifier: string, password?: string) => Promise;
addNativeAuthenticationMethod(ctx: RequestContext, user: User, identifier: string, password?: string) => Promise;
createAdminUser(ctx: RequestContext, identifier: string, password: string) => Promise;
createApiKeyUser(ctx: RequestContext, roles: Role[], identifier: string) => Promise;
softDelete(ctx: RequestContext, userId: ID) => ;
setVerificationToken(ctx: RequestContext, user: User) => Promise;
verifyUserByToken(ctx: RequestContext, verificationToken: string, password?: string) => Promise>;
setPasswordResetToken(ctx: RequestContext, emailAddress: string) => Promise;
resetPasswordByToken(ctx: RequestContext, passwordResetToken: string, password: string) => Promise<
User | PasswordResetTokenExpiredError | PasswordResetTokenInvalidError | PasswordValidationError
>;
changeUserAndNativeIdentifier(ctx: RequestContext, userId: ID, newIdentifier: string) => ;
setIdentifierChangeToken(ctx: RequestContext, user: User) => Promise;
changeIdentifierByToken(ctx: RequestContext, token: string) => Promise<
| { user: User; oldIdentifier: string }
| IdentifierChangeTokenInvalidError
| IdentifierChangeTokenExpiredError
>;
updatePassword(ctx: RequestContext, userId: ID, currentPassword: string, newPassword: string) => Promise;
}
```
### getUserById
\
RequestContext, userId: ID) => Promise<User | undefined>`} />
### getUserByEmailAddress
\RequestContext, emailAddress: string, userType?: 'administrator' | 'customer') => Promise<User | undefined>`} />
### createCustomerUser
\RequestContext, identifier: string, password?: string) => Promise<User | PasswordValidationError>`} />
Creates a new User with the special `customer` Role and using the [NativeAuthenticationStrategy](/current/core/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
### addNativeAuthenticationMethod
\RequestContext, user: User, identifier: string, password?: string) => Promise<User | PasswordValidationError>`} />
Adds a new [NativeAuthenticationMethod](/current/core/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) to the User. If the [AuthOptions](/current/core/reference/typescript-api/auth/auth-options#authoptions) `requireVerification`
is set to `true` (as is the default), the User will be marked as unverified until the email verification
flow is completed.
### createAdminUser
\RequestContext, identifier: string, password: string) => Promise<User>`} />
Creates a new verified User using the [NativeAuthenticationStrategy](/current/core/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
### createApiKeyUser
\RequestContext, roles: Role[], identifier: string) => Promise<User>`} />
Creates a new User which will be responsible for the permissions of an API-Key.
IMPORTANT: The caller is responsible for avoiding privilege escalations!
### softDelete
\RequestContext, userId: ID) => `} />
### setVerificationToken
\RequestContext, user: User) => Promise<User>`} />
Sets the [NativeAuthenticationMethod](/current/core/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) `verificationToken` as part of the User email verification
flow.
### verifyUserByToken
\RequestContext, verificationToken: string, password?: string) => Promise<ErrorResultUnionUser>>`} />
Verifies a verificationToken by looking for a User which has previously had it set using the
`setVerificationToken()` method, and checks that the token is valid and has not expired.
If valid, the User will be set to `verified: true`.
### setPasswordResetToken
\RequestContext, emailAddress: string) => Promise<User | undefined>`} />
Sets the [NativeAuthenticationMethod](/current/core/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) `passwordResetToken` as part of the User password reset
flow.
### resetPasswordByToken
\RequestContext, passwordResetToken: string, password: string) => Promise< User | PasswordResetTokenExpiredError | PasswordResetTokenInvalidError | PasswordValidationError >`} />
Verifies a passwordResetToken by looking for a User which has previously had it set using the
`setPasswordResetToken()` method, and checks that the token is valid and has not expired.
If valid, the User's credentials will be updated with the new password.
### changeUserAndNativeIdentifier
\RequestContext, userId: ID, newIdentifier: string) => `} />
Changes the User identifier without an email verification step, so this should be only used when
an Administrator is setting a new email address.
### setIdentifierChangeToken
\RequestContext, user: User) => Promise<User>`} />
Sets the [NativeAuthenticationMethod](/current/core/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) `identifierChangeToken` as part of the User email address change
flow.
### changeIdentifierByToken
\RequestContext, token: string) => Promise< | { user: User; oldIdentifier: string } | IdentifierChangeTokenInvalidError | IdentifierChangeTokenExpiredError >`} />
Changes the User identifier as part of the storefront flow used by Customers to set a
new email address, with the token previously set using the `setIdentifierChangeToken()` method.
### updatePassword
\RequestContext, userId: ID, currentPassword: string, newPassword: string) => Promise`} />
Updates the password for a User with the [NativeAuthenticationMethod](/current/core/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod).