יצירה וניהול של הזמנות משתמשים
בדף הזה מוסבר איך לבצע כמה פעולות בסיסיות באמצעות Cloud Identity User Invitation API.
לפני שמתחילים
הערה: לפני שמשתמשים בממשקי Cloud Identity API, צריך להגדיר את Cloud Identity. הוראות מפורטות זמינות במאמר הגדרת Cloud Identity.
לפני שממשיכים לקרוא את המידע בדף הזה, צריך לבצע את המשימות הבאות:
- מומלץ לקרוא את המאמר סקירה כללית על User Invitation API.
- מגדירים את User Invitation API.
בדיקת הזכאות להזמנה
כפי שצוין בסקירה הכללית, כדי להזמין חשבון משתמש, הוא צריך לעמוד בכמה קריטריונים. אפשר להשתמש בשיטה
IsInvitableUser()
כדי לברר אם חשבון משתמש מסוים עומד בדרישות.
REST
כדי לבדוק את הזכאות של חשבון משתמש, מתקשרים אל
customers.userinvitations.isInvitableUser()
עם מספר הלקוח וכתובת האימייל של החשבון.
בקשה לדוגמה
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser
שליפת הזמנות משתמש
ב-User Invitation API יש שיטות לאחזור הזמנה של משתמש יחיד ולאחזור של כל ההזמנות. כשמאחזרים את כל ההזמנות של המשתמשים, אפשר לסנן אותן לפי מצב ולהגדיר את סדר המיון.
אחזור של הזמנה למשתמש יחיד
REST
כדי לאחזר הזמנה של משתמש יחיד, מתקשרים אל
customers.userinvitations.get()
עם מספר הלקוח וכתובת האימייל של החשבון.
בקשה לדוגמה
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com
אחזור רשימה של הזמנות משתמשים
כל המשתמשים הלא מנוהלים מופיעים אוטומטית כהזמנות במצב NOT_YET_SENT, עד שמנהל או משתמש קצה מבצעים פעולה כלשהי. אחרי שהמשתמש מאשר את ההזמנה, החשבון כבר לא נחשב ללא מנוהל.
- אם מתקשרים אל
customers.userinvitations.list()עם המצב בבקשה, יוחזרו רק משתמשים שההזמנה שלהם נמצאת במצב הזה. - אם קוראים ל-
customers.userinvitations.list()בלי לציין את הסטטוס בבקשה, יוחזרו כל ההזמנות למשתמשים.
כדי לבדוק כמה סטטוסים, מוסיפים אופרטור or במסנן:
state=='accepted'||state=='declined'
REST
כדי לאחזר רשימה של הזמנות משתמשים, קוראים ל-customers.userinvitations.list() עם מזהה הלקוח וכל פרמטר שאילתה רצוי לסינון, למיון ולחלוקה לדפים של התוצאות. בדוגמה הבאה מוצגת רשימה של כל המשתמשים הלא מנוהלים, ממוינת לפי שעת העדכון האחרון בסדר יורד.
בקשה לדוגמה
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'
שליחת הזמנות למשתמשים
הזמנות למשתמשים לא נשלחות אוטומטית למשתמשים שעומדים בדרישות. אחרי שיש לכם רשימה של המשתמשים שאתם רוצים להזמין, אתם יכולים להשתמש בשיטה customers.userinvitations.send().
אם ההזמנה לא קיימת, היא תיווצר.
REST
כדי לשלוח למשתמש הזמנה באימייל, צריך להתקשר אל
customers.userinvitations.send()
עם מספר הלקוח וכתובת האימייל של חשבון המשתמש.
בקשה לדוגמה
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:send
ביטול הזמנות משתמשים
אפשר לבטל הזמנות משתמשים עד שהן מאושרות או נדחות. כדי לבטל הזמנה, מתקשרים אל השיטה customers.userinvitations.cancel().
REST
כדי לבטל הזמנה של משתמש, מתקשרים אל customers.userinvitations.cancel() עם מספר הלקוח וכתובת האימייל של חשבון המשתמש.
בקשה לדוגמה
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/writer@altostrat.com:cancel