הגדרת Confluence Cloud

בדף הזה מוסבר איך להגדיר את מופע Confluence Cloud לפני שיוצרים את מאגר הנתונים של Confluence Cloud.

הגדרת אימות והרשאות

צריך להגדיר אימות והרשאות במרכז ניהול החשבונות של Atlassian. זהו שלב חיוני כדי לאפשר למחבר לגשת לנתונים ולסנכרן אותם. מחבר Confluence Cloud תומך בשיטות אימות שונות, כמו פרטי כניסה של לקוח OAuth או טוקנים של API.

יצירת אפליקציית OAuth 2.0

כדי ליצור אפליקציית OAuth 2.0 לאימות, צריך לפעול לפי השלבים הבאים כדי להגדיר את האפליקציה ב-Atlassian Developer Console ולקבל את מזהה הלקוח ואת סוד הלקוח הנדרשים.

אימות גישת אדמין בארגון Confluence

כדי לאמת את הגישה של אדמין הארגון ב-Confluence:

1. נכנסים ל-Atlassian באמצעות פרטי הכניסה של המשתמש.

2. בוחרים באפליקציה Confluence.

3. לוחצים על הגדרות.

   אם האפשרות System (מערכת) מופיעה בקטע Confluence settings (הגדרות Confluence), יש לכם גישה כאדמינים ארגוניים ב-Confluence. אפשרות נוספת היא לבקש מהאדמין של הארגון ב-Confluence לתת לכם גישה.

יצירת אפליקציית OAuth 2.0

כדי ליצור אפליקציית OAuth 2.0:

1. נכנסים ל-Atlassian Developer Console.

2. לוחצים על סמל הפרופיל ובוחרים באפשרות מסוף למפתחים.

3. בדף Console, לוחצים על Create ובוחרים באפשרות OAuth 2.0 Integration.

4. בדף יצירת האפליקציה, מבצעים את הפעולות הבאות:

   1. מזינים שם לאפליקציה.

   2. מסמנים את התיבה כדי להסכים לתנאי המפתח של Atlassian.

   3. לוחצים על יצירה.

5. בדף האפליקציה, מבצעים את הפעולות הבאות:

   1. בתפריט הניווט, לוחצים על הרשאה.

   2. בטבלה Authorization type (סוג הרשאה), בוחרים באפשרות Add (הוספה) עבור OAuth 2.0 (3LO).

6. בשדה כתובת URL של קריאה חוזרת, מזינים את כתובת ה-URL בהתאם למצב החיבור של מאגר הנתונים.

   • הטמעת נתונים ופעולות: https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html

   • חיפוש מאוחד ופעולות: https://vertexaisearch.cloud.google.com/oauth-redirect

7. לוחצים על שמירת השינויים.

קבלת מזהה לקוח וסוד לקוח

כדי לקבל את מזהה הלקוח ואת סוד הלקוח:

1. בדף האפליקציה, בתפריט הניווט, לוחצים על הפצה.

2. בדף Distribution:

   1. בקטע אמצעי בקרה על ההפצה, לוחצים על עריכה.
   2. בקטע סטטוס ההפצה, בוחרים באפשרות שיתוף כדי לאפשר עריכה של שדות אחרים.
   3. מזינים את הפרטים בשדות החובה הבאים:
      1. בשדה Vendor (ספק), מזינים Google.
      2. בקטע מדיניות הפרטיות, מזינים את https://policies.google.com.
      3. בשדה האם האפליקציה שלך מאחסנת מידע אישי?, בוחרים באפשרות כן.
      4. מסמנים את תיבת הסימון אני מאשר/ת שהטמעתי את ממשק ה-API לדיווח על נתונים אישיים.
   4. לוחצים על שמירת השינויים.

3. בדף האפליקציה, מבצעים את הפעולות הבאות:

   1. בתפריט הניווט, לוחצים על הגדרות.
   2. בדף ההגדרות, מעתיקים את מזהה הלקוח ואת הסוד של הלקוח.

איך מקבלים מזהה מכונה וכתובת URL של מכונה

1. מקבלים את מזהה המכונה:

   1. פותחים כרטיסייה חדשה, מעתיקים את כתובת ה-URL של המופע ומוסיפים /_edge/tenant_info לכתובת ה-URL של המופע. לדוגמה, https://YOUR_INSTANCE.atlassian.net/_edge/tenant_info.
   2. עוברים לקישור כדי למצוא את הערך cloudId. ‫cloudId הוא מזהה המופע שלכם.

2. מציאת כתובת ה-URL של המופע:

   1. עוברים אל atlassian.net ונכנסים באמצעות חשבון אדמין.
   2. בוחרים את האפליקציה שרוצים לסנכרן. לדוגמה, מסנכרנים את האפליקציה הראשונה.
   3. מחפשים את כתובת ה-URL של המופע (תת-הדומיין בסרגל הכתובות).

הקצאת תפקידי אדמין

כדי להעניק לאדמין של Confluence את תפקיד העורך של Discovery Engine במסוף Google Cloud :

1. נכנסים לדף Gemini Enterprise במסוף Google Cloud .

2. עוברים אל IAM.

   כניסה לדף IAM

3. מאתרים את חשבון המשתמש עם גישת אדמין ב-Confluence ולוחצים על סמל העריכה .

4. נותנים את התפקיד 'עריכה ב-Discovery Engine' לאדמין.

כדי להעניק למשתמש תפקיד אדמין ב-Atlassian:

1. נכנסים אל Atlassian באמצעות חשבון אדמין של הארגון.

2. לוחצים על סמל התפריט ובוחרים את הארגון. אפשר גם להיכנס לכתובת admin.atlassian.com.

3. בדף אדמין, לוחצים על המוצר ובוחרים בלחצן ניהול משתמשים.

4. בקטע ניהול משתמשים, לוחצים על קבוצות.

5. בדף Groups:

   1. לוחצים על יצירת קבוצה.
   2. מזינים שם לקבוצה.

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

1. בדף הקבוצה, לוחצים על הוספת מוצר.

2. בוחרים את התפקיד אדמין עם גישת משתמש עבור Confluence.

3. בוחרים באפשרות אדמין מוצר בתור התפקיד של ניהול Confluence.

4. לוחצים על הענקת גישה.

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

הגדרת היקף ההרשאות המינימלי של האפליקציה

כדי להגדיר את OAuth 2.0 ולאחזר את פרטי הכניסה הנדרשים להגדרת מחבר Confluence, צריך לבצע את הפעולות הבאות:

1. כדי להגדיר היקפי הרשאה:

   1. לוחצים על הרשאות.

   2. מוסיפים את היקפי ההרשאות הנדרשים של Confluence API:

      1. עוברים אל Confluence API.
      2. לוחצים על הוספה > הגדרה.

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

      4. בוחרים את ההיקפים הנדרשים בהתאם למצב החיבור.

      הערה: בטבלה הבאה מפורטות ההרשאות הנדרשות לכל מצב חיבור. אם מפעילים את הפעולות באחד ממצבי הקישור חיפוש מאוחד או העברת נתונים, צריך גם לבחור את ההרשאות שמופיעות בשורה פעולות.

      הסיבה לשימוש	הרשאה	תיאור
      הטמעת נתונים	read:content-details:confluence	מאפשר למאגר הנתונים לקרוא פרטי תוכן ב-Confluence.
      	read:attachment:confluence	מאפשר למאגר הנתונים להוריד ולקרוא קבצים מצורפים.
      	read:comment:confluence	מאפשרת למאגר הנתונים לקרוא תגובות.
      	read:page:confluence	מאפשר למאגר הנתונים לקרוא דפים.
      	read:whiteboard:confluence	מאפשרת למאגר הנתונים לקרוא לוחות לבנים.
      	read:space:confluence	מאפשר למאגר הנתונים לקרוא מרחבים.
      	read:group:confluence	מאפשר למאגר הנתונים לקרוא קבוצות.
      	read:user:confluence	מאפשרת למאגר הנתונים לקרוא משתמשים.
      	read:content.metadata:confluence	מאפשר למאגר הנתונים לקרוא מטא-נתונים של תוכן.
      	read:configuration:confluence	מאפשרת למאגר הנתונים לקרוא הגדרות.
      חיפוש מאוחד	search:confluence	מאפשר למאגר הנתונים להריץ שאילתות חיפוש ב-Confluence.
      פעולות	write:page:confluence	מאפשר למאגר הנתונים ליצור ולעדכן דפים ב-Confluence.
      	write:attachment:confluence	מאפשרת למאגר הנתונים להעלות קבצים מצורפים לדפי Confluence.
      	write:blogpost:confluence	מאפשר למאגר הנתונים ליצור ולעדכן פוסטים בבלוג של Confluence.
      	write:space:confluence	מאפשר למאגר הנתונים ליצור ולעדכן מרחבים ב-Confluence.
      	write:confluence-space	מאפשר למאגר הנתונים לנהל את המידע של מרחב Confluence, כולל פעולות של יצירה, עדכון ומחיקה.
      	write:confluence-content	מאפשר למאגר הנתונים לכתוב תוכן ב-Confluence.
      	write:confluence-file	מאפשרת למאגר הנתונים להעלות קבצים מצורפים ל-Confluence.
      	read:attachment:confluence	מאפשר למאגר הנתונים להוריד ולקרוא קבצים מצורפים.
      	read:blogpost:confluence	מאפשר למאגר הנתונים לקרוא פוסטים בבלוג.
      	read:comment:confluence	מאפשרת למאגר הנתונים לקרוא תגובות.
      	read:configuration:confluence	מאפשרת למאגר הנתונים לקרוא הגדרות.
      	read:confluence-content.all	מאפשר למאגר הנתונים לקרוא את כל התוכן ב-Confluence.
      	read:confluence-space.summary	מאפשרת למאגר הנתונים לקרוא סיכומים של נפח האחסון.
      	read:content-details:confluence	מאפשר למאגר הנתונים לקרוא פרטי תוכן ב-Confluence.
      	read:content.metadata:confluence	מאפשר למאגר הנתונים לקרוא מטא-נתונים של תוכן.
      	read:group:confluence	מאפשר למאגר הנתונים לקרוא קבוצות.
      	read:page:confluence	מאפשר למאגר הנתונים לקרוא דפים.
      	read:space:confluence	מאפשר למאגר הנתונים לקרוא מרחבים.
      	read:space-details:confluence	מאפשר למאגר הנתונים לקרוא את פרטי המרחב.
      	read:task:confluence	מאפשר למאגר הנתונים לקרוא משימות.
      	read:user:confluence	מאפשרת למאגר הנתונים לקרוא משתמשים.
      	read:whiteboard:confluence	מאפשרת למאגר הנתונים לקרוא לוחות לבנים.
      	search:confluence	מאפשר למאגר הנתונים להריץ שאילתות חיפוש ב-Confluence.

   3. מוסיפים היקפי הרשאות של API לזיהוי משתמשים. ההיקף read:me נדרש כשפעולות מופעלות במאגר הנתונים:

      1. עוברים אל User Identity API.
      2. לוחצים על הוספה > הגדרה.
      3. עוברים לכרטיסייה היקפים גרנולריים ולוחצים על עריכת היקפים.
      4. בוחרים את ההיקף read:me.

      הסיבה לשימוש	הרשאה	תיאור
      פעולות	read:me	מאפשרת למאגר הנתונים לקרוא את פרטי המשתמש הנוכחי.

   4. מוודאים שכל ההיקפים נבחרו ושומרים את השינויים.

הגדרת אסימון API ב-Confluence

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

1. נכנסים ל-Atlassian Console.
2. לוחצים על Create API token (יצירת טוקן API).
3. מזינים שם לטוקן ה-API.
4. בוחרים תאריך תפוגה לטוקן ה-API. תקופת התפוגה של האסימון היא בין יום אחד ל-365 ימים.
5. לוחצים על יצירה.
6. שומרים את האסימון לשימוש מאוחר יותר.

ניהול הרשאות הגישה של משתמשים

כדי להפוך את כתובת האימייל של המשתמש לגלוי לכל מי שיש לו חשבון ב-Atlassian, פועלים לפי השלבים הבאים:

1. נכנסים ל-Atlassian Developer Console.

2. לוחצים על סמל הפרופיל ובוחרים באפשרות מסוף למפתחים.

3. לוחצים על סמל פרופיל המשתמש ובוחרים באפשרות ניהול החשבון.

4. עוברים אל פרופיל וחשיפה.

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

כדי להפוך את כתובת האימייל של המשתמש לגלוי לכל מי שיש לו גישה ל-Confluence, פועלים לפי השלבים הבאים:

1. נכנסים ל-Atlassian באמצעות פרטי הכניסה של המשתמש.

2. בוחרים אפליקציית Confluence.

3. לוחצים על הגדרות > מערכת.

4. בחלונית הימנית, בוחרים באפשרות הגדרה כללית.

5. לוחצים על עריכת ההגדרות.

6. בקטע חשיפת כתובת האימייל של המשתמש, בוחרים באפשרות גלוי לכולם.

7. לוחצים על עדכון.

התקנה והגדרה של User Identity Accessor ל-Confluence Cloud

אם כתובות האימייל של המשתמשים לא נגישות לציבור כברירת מחדל בגלל הגדרות הפרטיות ב-Confluence Cloud, צריך להתקין את האפליקציה User Identity Accessor for Confluence Cloud כדי לאחזר את כתובות האימייל של המשתמשים בצורה מאובטחת. אם כתובות האימייל של המשתמשים כבר גלויות לכולם, יכול להיות שלא תצטרכו להתקין את האפליקציה. מידע נוסף על הגבלת הגישה לכתובות אימייל זמין במאמר ניהול הגישה של המשתמשים והקצאת תפקידים.

תפקידים והרשאות

כדי להתקין ולהגדיר את האפליקציה User Identity Accessor for Confluence Cloud, צריך להיות לכם תפקיד אדמיניסטרטיבי מתאים ולהעניק את ההרשאות הנדרשות ברמת האפליקציה.

• הרשאה נדרשת: כדי להתקין ולהגדיר את האפליקציה, צריך להיות Confluence Site administrator.
• הרשאות ברמת האפליקציה: צריך להעניק את ההרשאות הבאות במהלך התקנת האפליקציה:
  • ‫Read Email Address: מאפשר לאפליקציה לאחזר בצורה מאובטחת כתובות אימייל של משתמשים, גם אם הניראות של הפרופיל מוגבלת.
  • ‫App Storage scope: מאפשרת לאפליקציה לקרוא ולכתוב בהתקן האחסון שלה.

התקנה של User Identity Accessor for Confluence Cloud

כדי להתקין את האפליקציה User Identity Accessor for Confluence Cloud באתר Confluence, פועלים לפי השלבים הבאים:

1. עוברים אל Atlassian Marketplace.

2. לוחצים על קבלת המינוי.

   

   להרשמה

3. ברשימה Select a site (בחירת אתר), בוחרים את אתר Confluence שבו רוצים להתקין את האפליקציה.

   הערה: כדי להתקין את האפליקציה, צריכות להיות לכם הרשאות אדמין באתר Confluence שנבחר.

4. לוחצים על בדיקה כדי לאשר את ההרשאות הנדרשות ולאשר את התנאים וההגבלות.

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

   אחרי ההתקנה, תופיע הודעת אישור: "האפליקציה נוספה למופע שלך והיא מוכנה לשימוש".

הגדרת User Identity Accessor ל-Confluence Cloud

אחרי שמתקינים את האפליקציה User Identity Accessor for Confluence Cloud, מגדירים מפתח API שהמערכת החיצונית (לדוגמה, מאגר הנתונים של Confluence Cloud) משתמשת בו כדי להפעיל בצורה מאובטחת את webtrigger של האפליקציה ולאחזר אימיילים.

כניסה לדף ההגדרות

כדי לגשת לדף ההגדרות של האפליקציה User Identity Accessor for Confluence Cloud ב-Confluence Cloud, פועלים לפי השלבים הבאים:

1. במופע של Confluence Cloud, לוחצים על סמל ההגדרות ⚙️ בתפריט הניווט.
2. בתפריט, בוחרים באפשרות אפליקציות.
3. בדף Apps administration, מאתרים את האפליקציה User Identity Accessor for Confluence Cloud ברשימה Manage apps.
4. לוחצים על Configure (הגדרה) או על הקישור שמשויך לאפליקציה. דף ההגדרה הייעודי של האפליקציה ייפתח ב-Confluence.

הגדרת מפתח API

כדי להגדיר את מפתח ה-API בדף ההגדרות, פועלים לפי השלבים הבאים:

1. בקטע API Key Configuration, מציינים את המפתח הסודי לאימות בקשות ל-webtrigger של האפליקציה. אפשר לאמת בקשות באמצעות אחת מהשיטות הבאות:

   • הזנת מפתח משלכם: מקלידים או מדביקים מפתח API חזק וייחודי בשדה 'מפתח API'. מומלץ להשתמש במפתח באורך של 20-30 תווים לפחות, עם שילוב של אותיות רישיות, אותיות קטנות, מספרים וסמלים.

   • יצירת מפתח: לוחצים על הלחצן יצירת מפתח חדש. המערכת יוצרת מפתח חזק ואקראי ומציגה אותו בשדה.

     חשוב: צריך להעתיק מיד את מפתח ה-API שמוצג בשדה. מטעמי אבטחה, יכול להיות שלא תוכלו לראות שוב את המפתח המלא אחרי שתשמרו אותו או תצאו מהדף. אם מאבדים את קוד הגישה, צריך להגדיר או ליצור קוד חדש.

2. לוחצים על Save API Key (שמירת מפתח API). תוצג הודעה שהמפתח נשמר בצורה מאובטחת.

הערה: מפתח ה-API שנוצר או נוצר מחדש בקטע הזה משמש כערך בשדה Confluence Identity Sync Forge Client Secret (סוד הלקוח של Confluence Identity Sync Forge) בקטע Advanced Options (אפשרויות מתקדמות) במהלך הגדרת מאגר הנתונים.

בדיקת הגדרות האפליקציה

כדי לוודא שהאפליקציה User Identity Accessor for Confluence Cloud מוגדרת בצורה נכונה, שולחים בקשה מהמערכת החיצונית ומאשרים שכתובות האימייל של המשתמשים מוחזרות בהצלחה.

קבלת כתובת ה-URL של ה-webtrigger

1. בדף Apps administration, מאתרים את הקטע Webtrigger URL שבו מוצגת כתובת ה-URL הייחודית שספציפית לאתר Confluence ולאפליקציה שהותקנה:
   • המערכת החיצונית צריכה להתקשר לכתובת ה-URL הזו כדי לבקש כתובות אימייל של משתמשים. לדוגמה, https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/WEBTRIGGER_ID, כאשר YOUR_INSTANCE_ID הוא מזהה מופע Confluence Cloud ו-WEBTRIGGER_ID הוא המזהה הייחודי של נקודת הקצה webtrigger שנוצרה עבור האפליקציה.
2. לוחצים על הלחצן העתקת כתובת URL או מעתיקים את כתובת ה-URL המלאה.

הגדרת המערכת החיצונית

• מגדירים את המערכת החיצונית שצריכה לאחזר כתובות אימייל של משתמשי Confluence באמצעות מפתח ה-API וכתובת ה-URL של webtrigger שהתקבלו בשלבים הקודמים.

  • כתובת ה-URL של נקודת הקצה: כתובת ה-URL של טריגר האינטרנט שהעתקתם.
  • שיטת ‏HTTP: ‏ POST

  • כותרות חובה:

    • Content-Type: application/json

    • X-Api-Key: YOUR_API_KEY

      מחליפים את YOUR_API_KEY במפתח ה-API שהגדרתם או שיצרתם בקטע הגדרת מפתח ה-API.

דוגמה לפקודת curl

בדוגמה הזו מוצגת קריאה ל-webtrigger‏ User Identity Accessor for Confluence Cloud, שמקבל מערך של מזהי חשבונות ומחזיר את כתובות האימייל.

curl --location --request POST 'https://YOUR_INSTANCE_ID.hello.atlassian-dev.net/x1/ENDPOINT_PATH' \
--header 'X-Api-Key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "accountIds": [
       "ACCOUNT_ID_1",
       "ACCOUNT_ID_2"
   ]
}'

מחליפים את:

• ‫YOUR_INSTANCE_ID עם מזהה המופע של Confluence Cloud
• ‫ENDPOINT_PATH עם נתיב נקודת קצה ל-API
• ‫YOUR_API_KEY עם מפתח ה-API שהגדרתם או שיצרתם בקטע הגדרת מפתח ה-API
• ‫ACCOUNT_ID עם מספרי החשבונות של Atlassian שרוצים לטרגט

התשובה הצפויה

[{"accountId":"ACCOUNT_ID_1","emailAddress":"EMAIL_ADDRESS_1"},
 {"accountId":"ACCOUNT_ID_2","emailAddress":"EMAIL_ADDRESS_2"}]

מחליפים את:

• ACCOUNT_ID_X עם מזהי חשבון Atlassian בפועל
• ‫USER_EMAIL_X עם כתובות האימייל של המשתמשים שמוחזרות מקריאה ל-API

הטמעה של שיטות מומלצות לאבטחה

כדי לוודא שמפתח ה-API מאובטח, כדאי לפעול לפי ההמלצות הבאות:

• מאחסנים את מפתח ה-API בצורה מאובטחת בהגדרות של מאגר הנתונים של Confluence Cloud.
• מוודאים שכל התקשורת עם כתובת ה-URL של ה-webhook מתבצעת באמצעות HTTPS. זוהי ברירת המחדל עבור User Identity Accessor for Confluence Cloud webtriggers.

תמיכה ב-User Identity Accessor ל-Confluence Cloud

אפשר לקבל הצעות לתמיכה מ- Google באפליקציה User Identity Accessor for Confluence Cloud, שיכולות לכלול תחזוקה ועדכונים שוטפים כדי שהאפליקציה תהיה מעודכנת. אם נתקלתם בבעיות או שיש לכם שאלות ספציפיות לגבי הפונקציונליות של האפליקציה, אתם יכולים לפנות אל Google Cloud התמיכה.