#אימות

#סקירה כללית

המחלקה Auth משמשת בעיקר בצד הלקוח (client-side) לגישה לפרטי משתמש ולשליחת בקשות ל-API הקשורות לאימות משתמשים.

#מאפייני מופע

#locale

השפה שבה משתמש המשתמש הנוכחי.

#role

התפקיד (role) שבו משתמש המשתמש הנוכחי.

#token

ה-token של ה-API.

#authenticator

המאמת (authenticator) המשמש לאימות המשתמש הנוכחי. ראו אימות משתמשים.

#מתודות מחלקה

#signIn()

כניסת משתמש.

#חתימה

• async signIn(values: any, authenticator?: string): Promise<AxiosResponse<any>>

#פרטים

שם פרמטר	טיפוס	תיאור
values	any	פרמטרי הבקשה עבור API הכניסה.
authenticator	string	המזהה של המאמת המשמש לכניסה.

#signUp()

הרשמת משתמש.

#חתימה

• async signUp(values: any, authenticator?: string): Promise<AxiosResponse<any>>

#פרטים

שם פרמטר	טיפוס	תיאור
values	any	פרמטרי הבקשה עבור API ההרשמה.
authenticator	string	המזהה של המאמת המשמש להרשמה.

#signOut()

יציאה מהחשבון.

#חתימה

• async signOut(values: any, authenticator?: string): Promise<AxiosResponse<any>>

#פרטים

שם פרמטר	טיפוס	תיאור
values	any	פרמטרי הבקשה עבור API היציאה מהחשבון.
authenticator	string	המזהה של המאמת המשמש ליציאה מהחשבון.