הגדרות של 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).

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

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

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

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

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

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

  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. בתפריט הניווט, לוחצים על מרחבים.

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

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

  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. בדף קבוצות:

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

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

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

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

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

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

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

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

    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. לוחצים על הגדרה.

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

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

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

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

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

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

    מצב החיבור הרשאה מטרה
    חיפוש ופעולות מאוחדים write:comment:jira מאפשר למאגר הנתונים לפרסם תגובות או תשובות חדשות ישירות מממשק החיפוש.
    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: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 העוזר הדיגיטלי יכול ליצור או לשנות בעיות.
    <!--Data ingestion-->הטמעת נתונים read:user:jira, read:group:jira, read:avatar:jira מאפשרת סריקה ואינדוקס של תוכן Jira ושל קשרי משתמשים.
    read:issue-security-level:jira, read:issue-security-scheme:jira מאפשר מיפוי הרשאות כך שרק משתמשים מורשים יוכלו לחפש את הנתונים שהועברו.
    read:audit-log:jira מאפשר למנוע הסנכרון לזהות אילו פריטים עודכנו או נמחקו.

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

התקנת Accessor של זהות המשתמש

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

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

  2. לוחצים על קבל עכשיו.

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

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

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

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

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

הגדרת ה-accessor של זהות המשתמש

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

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

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

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

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

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

הגדרת מפתח ה-API

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

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

    • הזנת מפתח משלכם: מקלידים או מדביקים מפתח API חזק וייחודי משלכם בשדה API Key. השתמשו במפתח של 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.
  • מוודאים שכל התקשורת עם כתובת ה-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.