הגדרות של Jira Cloud

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

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

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

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

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

אימות הגישה של אדמין בארגון Jira

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

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

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

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

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

יצירת אפליקציית 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).

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

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

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

      .

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

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

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

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

  2. בדף Distribution:

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

קבלת מפתח פרויקט

כדי לקבל את מפתח הפרויקט:

  1. נכנסים לחשבון Jira Cloud.

  2. בתפריט הניווט, בוחרים באפשרות Spaces (מרחבים).

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

  4. פותחים בעיה כלשהי בפרויקט ולוחצים על more_horiz פעולות.

  5. לוחצים על ייצוא XML ומורידים את הקובץ.

  6. פותחים את קובץ ה-XML שהורד ומחפשים את התג שמכיל את project id. מעתיקים את הערך שמשויך לתג הזה לשימוש בהמשך.

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

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

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

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

    כניסה לדף IAM

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

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

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

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

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

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

    manage-users
    ניהול משתמשים

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

  5. בדף Groups:

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

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

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

  2. בוחרים באפשרות User access admin (אדמין לגישת משתמשים) בתור התפקיד עבור Jira.

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

    jira-user-access-admin
    אדמין עם גישת משתמש ב-Jira

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

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

    add-group-members
    איך מצרפים אנשים לקבוצות

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

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

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

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

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

    manage-account
    ניהול החשבון

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

    profile-visibility
    פרופיל וחשיפה

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

    contact
    יצירת קשר

כדי שכתובת האימייל של המשתמש תהיה גלויה לכל מי שיש לו גישה ל-Jira:

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

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

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

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

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

  6. בקטע User email visibility (חשיפת כתובת האימייל של המשתמש), בוחרים באפשרות Public (גלוי לכולם).

    בחירת רמת החשיפה של כתובת האימייל
    בחירת הרשאות הגישה לאימייל

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

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

כדי לבצע את הפעולות שמוגדרות, צריך להגדיר את ההרשאות הבאות למחבר Jira Cloud בפלטפורמת Atlassian.

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

  2. עוברים אל Jira API ולוחצים על Add (הוספה).

  3. לוחצים על Configure (הגדרה).

  4. עוברים לכרטיסייה היקפי הרשאות קלאסיים.

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

    אמצעי תחבורה הרשאה מטרה
    חיפוש מאוחד ופעולות מאוחדות read:jira-user, read:jira-work מאפשרת ל-Assistant לאחזר ולהציג תוצאות חיפוש ופרטי משתמש בזמן אמת.
    write:jira-work מאפשר לעוזר הדיגיטלי לשנות פריטי עבודה (לדוגמה, לעדכן שדות של בעיות), לנהל הערות או בעיות ולהעלות קבצים מצורפים.
    חיפוש מאוחד בלבד read:jira-user, read:jira-work ההרשאה מאפשרת ל-Assistant לחפש בעיות, פרויקטים ופרופילי משתמשים ולהציג אותם.
    העברת נתונים ופעולות read:jira-work מאפשרת ל-Assistant לבצע סריקה רחבה של נתונים וליצור אינדקס של פריטי עבודה.
    write:jira-work מאפשר לעוזר לבצע פעולות כתיבה (יצירה, עדכונים, תגובות וקבצים מצורפים) בפריטי עבודה בסביבה שהועברה.
    הטמעת נתונים read:jira-work מאפשר ל-Assistant לסרוק ולאנדקס תוכן ב-Jira כדי שיהיה זמין לחיפוש.

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

  7. עוברים לכרטיסייה היקפי גישה מפורטים.

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

אמצעי תחבורה הרשאה מטרה
חיפוש מאוחד ופעולות מאוחדות write:comment:jira מאפשרת למאגר הנתונים לפרסם תגובות או תשובות חדשות ישירות מממשק Gemini Enterprise.
write:issue:jira מאפשרת למאגר הנתונים ליצור בעיות חדשות או לבצע עריכות משמעותיות בבעיות קיימות.
write:attachment:jira מאפשר למאגר הנתונים להעלות קבצים מצורפים לבעיות ב-Jira.
read:issue:jira מאפשר למאגר הנתונים לקרוא בעיות.
read:issue-type:jira מאפשר למאגר הנתונים לקרוא סוגי בעיות.
read:comment:jira מאפשרת למאגר הנתונים לקרוא תגובות.
read:comment.property:jira מאפשר למאגר הנתונים לקרוא מאפיינים של תגובות לבעיות.
read:project:jira מאפשר למאגר הנתונים לקרוא פרויקטים.
read:priority:jira מאפשר למאגר הנתונים לקרוא את העדיפויות.
read:issue.transition:jira מאפשרת למאגר הנתונים לקרוא מעברים בין סטטוסים של בעיות.
read:issue-meta:jira מאפשר למאגר הנתונים לקרוא את המטא-נתונים של הבעיות.
read:board-scope.admin:jira-software מאפשרת למאגר הנתונים לקרוא את ההגדרה, את התכונות של הפרויקט, את המסננים, את המאפיינים ואת המסננים המהירים של לוח.
read:board-scope:jira-software מאפשרת למאגר הנתונים לקרוא לוחות, בעיות בלוח, בעיות מתוך backlog, דוחות וגרסאות.
read:issue-details:jira מאפשר למאגר הנתונים לקרוא פרטים על בעיות.
read:jql:jira מאפשר למאגר הנתונים לקרוא שאילתות ב-Jira Query Language‏ (JQL).
חיפוש מאוחד בלבד read:issue:jira מאפשר למאגר הנתונים לקרוא בעיות.
read:issue-type:jira מאפשר למאגר הנתונים לקרוא סוגי בעיות.
read:comment:jira מאפשרת למאגר הנתונים לקרוא תגובות.
read:comment.property:jira מאפשר למאגר הנתונים לקרוא מאפיינים של תגובות לבעיות.
read:project:jira מאפשר למאגר הנתונים לקרוא פרויקטים.
read:priority:jira מאפשר למאגר הנתונים לקרוא את העדיפויות.
read:issue.transition:jira מאפשרת למאגר הנתונים לקרוא מעברים בין סטטוסים של בעיות.
read:issue-meta:jira מאפשר למאגר הנתונים לקרוא את המטא-נתונים של הבעיות.
read:board-scope.admin:jira-software מאפשרת למאגר הנתונים לקרוא את ההגדרה, את התכונות של הפרויקט, את המסננים, את המאפיינים ואת המסננים המהירים של לוח.
read:board-scope:jira-software מאפשרת למאגר הנתונים לקרוא לוחות, בעיות בלוח, בעיות מתוך backlog, דוחות וגרסאות.
read:sprint:jira-software מאפשר למאגר הנתונים לקרוא את פרטי הספרינט.
read:issue-details:jira מאפשר למאגר הנתונים לקרוא פרטים על בעיות.
read:jql:jira מאפשר למאגר הנתונים לקרוא שאילתות ב-Jira Query Language‏ (JQL).
העברת נתונים ופעולות read:user:jira, read:group:jira, read:avatar:jira מאפשרת לסנכרן מטא-נתונים של משתמשים או קבוצות ולהציג פרופילי משתמשים.
read:issue-security-level:jira, read:issue-security-scheme:jira מאפשר בקרת גישה, כדי לוודא שהנתונים שהועברו מכבדים את גבולות האבטחה של Jira.
read:audit-log:jira מאפשר לעקוב אחרי שינויים ולבצע סנכרונים מצטברים כדי לשמור על עדכניות הנתונים שהועברו.
write:comment:jira מאפשר להוסיף הערות לבעיות באמצעות מאגר הנתונים.
write:issue:jira מאפשרת ל-Assistant ליצור או לשנות בעיות.
הטמעת נתונים read:user:jira, read:group:jira, read:avatar:jira מאפשרת סריקה ואינדוקס של תוכן Jira ושל קשרי משתמשים.
read:issue-security-level:jira, read:issue-security-scheme:jira מאפשר מיפוי הרשאות כך שרק משתמשים מורשים יוכלו לחפש את הנתונים שהועברו.
read:audit-log:jira מאפשר למנוע הסנכרון לזהות אילו פריטים עודכנו או נמחקו.
read:sprint:jira-software מאפשר למאגר הנתונים לקרוא את פרטי הספרינט.

‫9. מוודאים שכל ההיקפים נבחרו ולוחצים על שמירה.

התקנה של User Identity Accessor

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

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

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

    configure-uia-button-jira
    להרשמה

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

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

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

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

הגדרה של User Identity Accessor

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

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

כדי לגשת לדף ההגדרות של האפליקציה User Identity Accessor for Jira Cloud:

  1. במופע של Jira Cloud, לוחצים על סמל ההגדרות ⚙️ בתפריט הניווט.
  2. בתפריט, בוחרים באפשרות אפליקציות.
  3. בדף ניהול אפליקציות, מאתרים את האפליקציה User Identity Accessor for Jira Cloud.

  4. לוחצים על Configure (הגדרה) או על הקישור שמשויך לאפליקציה. דף ההגדרה הייעודי של האפליקציה ייפתח ב-Jira Cloud.

    configure-uia-button-jira
    הגדרת כלי הגישה לזהות המשתמש באפליקציית Jira Cloud

הגדרת מפתח API

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

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

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

      save-key
      מזינים מפתח משלכם

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

      generate-key
      יצירת מפתח

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

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

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

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

קבלת כתובת ה-URL של טריגר האינטרנט

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

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

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

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

  • שיטת ‏HTTP: ‏ POST

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

    • Content-Type: application/json

    • X-Api-Key: YOUR_API_KEY

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

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

בדוגמה הזו מוצגת קריאה לטריגר האינטרנט User Identity Accessor for Jira 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 עם מזהה המופע של Jira 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 בצורה מאובטחת בהגדרות של Jira Cloud Connector.
  • מוודאים שכל התקשורת עם כתובת ה-URL של ה-webhook מתבצעת באמצעות HTTPS. זוהי ברירת המחדל עבור טריגרים באינטרנט של User Identity Accessor for Jira Cloud.

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

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