ספריית JavaScript של צד שלישי לאימות ב-Google עבור אתרים - הפניה לממשק API

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

ההפניה הזו מתארת את ממשק ה-API של JavaScript לספריית ההרשאות של צד שלישי ב-Google, שבו ניתן להשתמש כדי לטעון קודי הרשאה או אסימוני גישה מ-Google.

שיטה: google.accounts.oauth2.initCodeClient

השיטה initCodeClient מאתחלת ומחזירה לקוח קוד עם ההגדרות האישיות בפרמטר.

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

סוג נתונים: CodeClientConfig

בטבלה הבאה מפורטים המאפיינים של סוג הנתונים CodeClientConfig.

נכסים
client_id חובה. מזהה הלקוח של האפליקציה שלך. אפשר למצוא את הערך הזה בקונסולה לממשקי API.
scope חובה. רשימה של היקפים מופרדים ברווחים שמזהים את המשאבים שאליהם האפליקציה יכולה לגשת, בשם המשתמש. הערכים האלה מיידעים את מסך ההסכמה ש-Google מציגה למשתמש.
include_granted_scopes אופציונלי, ברירת המחדל היא true. מאפשרת לאפליקציות להשתמש בהרשאה מצטברת כדי לבקש גישה להיקפי הרשאות נוספים בהקשר. אם מגדירים את הערך של הפרמטר הזה ל-false ובקשת ההרשאה תאושר, אסימון הגישה החדש יתייחס רק להיקפי ההרשאות ש-scope ביקש עבורם ב-CodeClientConfig.
redirect_uri חובה ביחס ל-UX שמיועד להפניה אוטומטית. המדיניות הזו קובעת איפה שרת ה-API מפנה את המשתמש אחרי שהוא מסיים את תהליך ההרשאה. הערך צריך להיות זהה לאחד ממזהי ה-URI המותרים להפניה מחדש עבור לקוח OAuth 2.0, שהגדרתם במסוף API, ועליהם לציית לכללי האימות של URI של הפניה מחדש. מאפיין ה-UX הקופץ יתעלם מהנכס.
callback נדרשת עבור חוויית המשתמש בחלונות קופצים. פונקציית JavaScript שמטפלת בתגובת קוד שמוחזרת. מאפיין ה-UX המיועד להפניה אוטומטית יתעלם מהנכס.
state אופציונלי. מומלץ עבור חוויית משתמש עם הפניה אוטומטית. מציינת את ערך המחרוזת שבו האפליקציה שלך משתמשת כדי לשמור את המצב בין בקשת ההרשאה שלך לבין התגובה של שרת ההרשאות.
enable_serial_consent אופציונלי, ברירת המחדל היא true. אם המדיניות מקבלת את הערך false, הרשאות מפורטות יותר של חשבון Google יושבתו עבור מזהי לקוחות OAuth שנוצרו לפני 2019. אין השפעה על מזהי לקוח חדשים יותר של OAuth, מפני שהרשאות מפורטות יותר תמיד מופעלות עבורן.
hint אופציונלי. אם האפליקציה יודעת איזה משתמש צריך לאשר את הבקשה, היא יכולה להשתמש בנכס הזה כדי לספק רמז ל-Google. כתובת האימייל של משתמש היעד. מידע נוסף זמין בשדה login_hint במסמכי ה-OpenID Connect.
hosted_domain אופציונלי. אם האפליקציה מכירה את דומיין Workspace שהמשתמש שייך אליו, יש להשתמש בכך כדי לספק ל-Google רמז. מידע נוסף זמין בשדה hd במסמכי ה-OpenID Connect.
ux_mode אופציונלי. מצב חוויית המשתמש שבו יש להשתמש בתהליך ההרשאה. כברירת מחדל, תהליך קבלת ההסכמה ייפתח בחלון קופץ. הערכים החוקיים הם popup ו-redirect.
select_account אופציונלי, ברירת המחדל היא 'false'. ערך בוליאני כדי לבקש מהמשתמש לבחור חשבון.
error_callback אופציונלי. פונקציית JavaScript המטפלת בכמה שגיאות שאינן OAuth, כגון החלון הקופץ, נכשלת, או נסגרת לפני החזרת תגובת OAuth.

השדה 'type' בפרמטר של הקלט מציין את הסיבה המפורטת.
  • pop_failed_to_open פתיחת החלון הקופץ נכשלה.
  • pop_closed החלון הקופץ ייסגר לפני החזרת תגובת OAuth.
  • מציין מיקום לא ידוע עבור שגיאות אחרות.

סוג נתונים: CodeClient

בכיתה יש רק קוד בקשה ציבורי אחד, שמפעיל את תהליך ה-UX בקוד OAuth 2.0.

interface CodeClient {
  requestCode(): void;
}

סוג נתונים: CodeResponse

אובייקט JavaScript של CodeResponse יועבר לשיטה callback ב-UX הקופץ. בממשק ה-UX, ההפניה של CodeResponse תעבור כפרמטרים של כתובת אתר.

בטבלה הבאה מפורטים המאפיינים של סוג הנתונים CodeResponse.

נכסים
code קוד ההרשאה של תגובת אסימון מוצלחת.
scope רשימה של היקפים מופרדים ברווחים שאושרו על ידי המשתמש.
state ערך המחרוזת שמשמש את האפליקציה כדי לשמור על המצב בין בקשת ההרשאה שלך לבין התגובה.
error קוד שגיאת ASCII יחיד.
error_description טקסט ASCII קריא לבני אדם, המספק מידע נוסף שנועד לסייע למפתח הלקוח להבין את השגיאה שאירעה.
error_uri URI שמזהה דף אינטרנט שמכיל מידע על השגיאה, ומשמש כדי לספק למפתח הלקוח מידע נוסף על השגיאה.

שיטה: google.accounts.oauth2.initTokenClient

השיטה initTokenClient מאתחלת ומחזירה לקוח אסימון באמצעות ההגדרות האישיות בפרמטר.

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

סוג הנתונים: TokenClientConfig

בטבלה הבאה מפורטים המאפיינים של סוג הנתונים TokenClientConfig.

נכסים
client_id חובה. מזהה הלקוח של האפליקציה שלך. אפשר למצוא את הערך הזה במסוף ה-API.
callback חובה. פונקציית JavaScript המטפלת בתגובת אסימון מוחזרת.
scope חובה. רשימה של היקפים מופרדים ברווחים שמזהים את המשאבים שאליהם האפליקציה יכולה לגשת, בשם המשתמש. הערכים האלה מיידעים את מסך ההסכמה ש-Google מציגה למשתמש.
include_granted_scopes אופציונלי, ברירת המחדל היא true. מאפשרת לאפליקציות להשתמש בהרשאה מצטברת כדי לבקש גישה להיקפי הרשאות נוספים בהקשר. אם מגדירים את הערך של הפרמטר הזה ל-false ובקשת ההרשאה תאושר, אסימון הגישה החדש יתייחס רק להיקפי ההרשאות ש-scope ביקש עבורם ב-TokenClientConfig.
prompt אופציונלי, ערך ברירת המחדל הוא 'select_account'. רשימה של בקשות להצגת בקשות גדולות וקטנות, שבהן המשתמש צריך להציג אותן. הערכים האפשריים הם:
  • מחרוזת ריקה, המשתמש יקבל הודעה רק בפעם הראשונה שהאפליקציה תבקש גישה. לא ניתן לציין אותם באמצעות ערכים אחרים.
  • 'none' לא יוצגו מסכי אימות או הסכמה. אין לציין ערכים אחרים.
  • 'Consent' (בקשת הסכמה) מהמשתמש.
  • 'select_account' מנחה את המשתמש לבחור חשבון.
enable_serial_consent אופציונלי, ברירת המחדל היא true. אם המדיניות מקבלת את הערך false, הרשאות מפורטות יותר של חשבון Google יושבתו עבור מזהי לקוחות OAuth שנוצרו לפני 2019. אין השפעה על מזהי לקוח חדשים יותר של OAuth, מפני שהרשאות מפורטות יותר תמיד מופעלות עבורן.
hint אופציונלי. אם האפליקציה יודעת איזה משתמש צריך לאשר את הבקשה, היא יכולה להשתמש בנכס הזה כדי לספק רמז ל-Google. כתובת האימייל של משתמש היעד. מידע נוסף זמין בשדה login_hint במסמכי ה-OpenID Connect.
hosted_domain אופציונלי. אם האפליקציה מכירה את דומיין Workspace שהמשתמש שייך אליו, יש להשתמש בכך כדי לספק ל-Google רמז. מידע נוסף זמין בשדה hd במסמכי ה-OpenID Connect.
state אופציונלי. לא מומלץ. מציינת את ערך המחרוזת שבו האפליקציה שלך משתמשת כדי לשמור את המצב בין בקשת ההרשאה שלך לבין התגובה של שרת ההרשאות.
error_callback אופציונלי. פונקציית JavaScript המטפלת בכמה שגיאות שאינן OAuth, כגון החלון הקופץ, נכשלת, או נסגרת לפני החזרת תגובת OAuth.

השדה 'type' בפרמטר של הקלט מציין את הסיבה המפורטת.
  • pop_failed_to_open פתיחת החלון הקופץ נכשלה.
  • pop_closed החלון הקופץ ייסגר לפני החזרת תגובת OAuth.
  • מציין מיקום לא ידוע עבור שגיאות אחרות.

סוג הנתונים: TokenClient

בכיתה יש רק שיטה ציבורית אחת requestAccessToken, שמפעילה את תהליך ה-UX באסימון OAuth 2.0.

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
ארגומנטים
overrideConfig OverridableTokenClientConfig אופציונלי. התצורות שיש לבטל בשיטה הזו.

סוג נתונים: OverridableTokenClientConfig

בטבלה הבאה מפורטים המאפיינים של סוג הנתונים OverridableTokenClientConfig.

נכסים
scope אופציונלי. רשימה של היקפים מופרדים ברווחים שמזהים את המשאבים שלאפליקציה שלך תהיה גישה אליהם בשם המשתמש. הערכים האלה מייצגים את מסך ההסכמה ש-Google מציגה למשתמש.
include_granted_scopes אופציונלי, ברירת המחדל היא true. מאפשרת לאפליקציות להשתמש בהרשאה מצטברת כדי לבקש גישה להיקפי הרשאות נוספים בהקשר. אם מגדירים את הערך של הפרמטר הזה ל-false ובקשת ההרשאה תאושר, אסימון הגישה החדש יתייחס רק להיקפי ההרשאות ש-scope ביקש עבורם ב-OverridableTokenClientConfig.
prompt אופציונלי. רשימה של בקשות להצגת תווי אישור, מופרדת ברווחים, עבור המשתמש.
enable_serial_consent אופציונלי, ברירת המחדל היא true. אם המדיניות מקבלת את הערך false, הרשאות מפורטות יותר של חשבון Google יושבתו עבור מזהי לקוחות OAuth שנוצרו לפני 2019. אין השפעה על מזהי לקוח חדשים יותר של OAuth, מפני שהרשאות מפורטות יותר תמיד מופעלות עבורן.
hint אופציונלי. אם האפליקציה יודעת איזה משתמש צריך לאשר את הבקשה, היא יכולה להשתמש בנכס הזה כדי לספק רמז ל-Google. כתובת האימייל של משתמש היעד. מידע נוסף זמין בשדה login_hint במסמכי ה-OpenID Connect.
state אופציונלי. לא מומלץ. מציינת את ערך המחרוזת שבו האפליקציה שלך משתמשת כדי לשמור את המצב בין בקשת ההרשאה שלך לבין התגובה של שרת ההרשאות.

סוג הנתונים: TokenResponse

אובייקט JavaScript TokenResponse יועבר לשיטת ההתקשרות חזרה בממשק המשתמש הקופץ.

בטבלה הבאה מפורטים המאפיינים של סוג הנתונים TokenResponse.

נכסים
access_token אסימון הגישה של תגובת אסימון מוצלחת.
expires_in משך החיים (בשניות) של אסימון הגישה.
hd הדומיין המתארח שהמשתמש שייך אליו.
prompt ערך הבקשה שהיה בשימוש מרשימת הערכים האפשריים שצוינה על ידי TokenClientConfig או OverridableTokenClientConfig.
token_type סוג האסימון שהונפק.
scope רשימה של היקפים מופרדים ברווחים שאושרו על ידי המשתמש.
state ערך המחרוזת שמשמש את האפליקציה כדי לשמור על המצב בין בקשת ההרשאה שלך לבין התגובה.
error קוד שגיאת ASCII יחיד.
error_description טקסט ASCII קריא לבני אדם, המספק מידע נוסף שנועד לעזור למפתח הלקוח להבין את השגיאה שאירעה.
error_uri URI שמזהה דף אינטרנט שמכיל מידע על השגיאה, ומשמש כדי לספק למפתח הלקוח מידע נוסף על השגיאה.

שיטה: google.accounts.oauth2.hasgrantedAllScopes

בודקת אם המשתמש העניק את כל ההיקפים או ההיקפים שצוינו.

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;
ארגומנטים
tokenResponse TokenResponse חובה. אובייקט TokenResponse.
firstScope מחרוזת חובה. ההיקף שצריך לבדוק.
restScopes מחרוזת[] אופציונלי. היקפים נוספים לבדיקה.
החזרות
boolean הערך הוא True אם כל ההיקפים מותרים.

שיטה: google.accounts.oauth2.hasgrantedEveryScope

בודקת אם המשתמש נתן היקף או היקפים שצוינו.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
ארגומנטים
tokenResponse TokenResponse חובה. אובייקט TokenResponse.
firstScope מחרוזת חובה. ההיקף שצריך לבדוק.
restScopes מחרוזת[] אופציונלי. היקפים נוספים לבדיקה.
החזרות
boolean הערך הוא True אם היקפי ההרשאות האלה מותרים.

שיטה: google.accounts.oauth2.revoke

השיטה revoke מבטלת את כל היקפי ההרשאות שהמשתמש העניק לאפליקציה. נדרש אסימון גישה חוקי כדי לבטל את ההרשאה.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
ארגומנטים
accessToken מחרוזת חובה. אסימון גישה תקין.
done פונקציה אופציונלי. פונקציית קריאה חוזרת בסיום פעולת הביטול.