mirror of
https://github.com/matrix-org/matrix-hookshot.git
synced 2025-03-10 21:19:13 +00:00
406 lines
28 KiB
HTML
406 lines
28 KiB
HTML
|
<!DOCTYPE HTML>
|
|||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|||
|
|
<head>
|
|||
|
|
<!-- Book generated using mdBook -->
|
|||
|
|
<meta charset="UTF-8">
|
|||
|
|
<title>Provisioning - Matrix Hookshot</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!-- Custom HTML head -->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|||
|
|
<meta name="description" content="">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|||
|
|
<meta name="theme-color" content="#ffffff" />
|
|||
|
|
|
|||
|
|
<link rel="icon" href="../favicon.svg">
|
|||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|||
|
|
<link rel="stylesheet" href="../css/general.css">
|
|||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|||
|
|
|
|||
|
|
<!-- Fonts -->
|
|||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|||
|
|
|
|||
|
|
<!-- Highlight.js Stylesheets -->
|
|||
|
|
<link rel="stylesheet" href="../highlight.css">
|
|||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|||
|
|
|
|||
|
|
<!-- Custom theme stylesheets -->
|
|||
|
|
<link rel="stylesheet" href="../docs/_site/style.css">
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<!-- Provide site root to javascript -->
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
var path_to_root = "../";
|
|||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
try {
|
|||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|||
|
|
|
|||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|||
|
|
}
|
|||
|
|
} catch (e) { }
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
var theme;
|
|||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|||
|
|
var html = document.querySelector('html');
|
|||
|
|
html.classList.remove('no-js')
|
|||
|
|
html.classList.remove('light')
|
|||
|
|
html.classList.add(theme);
|
|||
|
|
html.classList.add('js');
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
var html = document.querySelector('html');
|
|||
|
|
var sidebar = 'hidden';
|
|||
|
|
if (document.body.clientWidth >= 1080) {
|
|||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|||
|
|
sidebar = sidebar || 'visible';
|
|||
|
|
}
|
|||
|
|
html.classList.remove('sidebar-visible');
|
|||
|
|
html.classList.add("sidebar-" + sidebar);
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|||
|
|
<div class="sidebar-scrollbox">
|
|||
|
|
<ol class="chapter"><li class="chapter-item expanded "><a href="../hookshot.html"><strong aria-hidden="true">1.</strong> ℹ️ Hookshot</a></li><li class="chapter-item expanded "><a href="../setup.html"><strong aria-hidden="true">2.</strong> ⚙️ Setup</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/sample-configuration.html"><strong aria-hidden="true">2.1.</strong> 📃 Sample Configuration</a></li><li class="chapter-item expanded "><a href="../setup/feeds.html"><strong aria-hidden="true">2.2.</strong> Feed</a></li><li class="chapter-item expanded "><a href="../setup/figma.html"><strong aria-hidden="true">2.3.</strong> Figma</a></li><li class="chapter-item expanded "><a href="../setup/github.html"><strong aria-hidden="true">2.4.</strong> GitHub</a></li><li class="chapter-item expanded "><a href="../setup/gitlab.html"><strong aria-hidden="true">2.5.</strong> GitLab</a></li><li class="chapter-item expanded "><a href="../setup/jira.html"><strong aria-hidden="true">2.6.</strong> JIRA</a></li><li class="chapter-item expanded "><a href="../setup/webhooks.html"><strong aria-hidden="true">2.7.</strong> Webhooks</a></li></ol></li><li class="chapter-item expanded "><a href="../usage.html"><strong aria-hidden="true">3.</strong> 👤 Usage</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/dynamic_rooms.html"><strong aria-hidden="true">3.1.</strong> Dynamic Rooms</a></li><li class="chapter-item expanded "><a href="../usage/auth.html"><strong aria-hidden="true">3.2.</strong> Authenticating</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration.html"><strong aria-hidden="true">3.3.</strong> Room Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/room_configuration/github_repo.html"><strong aria-hidden="true">3.3.1.</strong> GitHub Repo</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration/gitlab_project.html"><strong aria-hidden="true">3.3.2.</strong> GitLab Project</a></li><li class="chapter-item expanded "><a href="../usage/room_configuration/jira_project.html"><strong aria-hidden="true">3.3.3.</strong> JIRA Project</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../metrics.html"><strong aria-hidden="true">4.</strong> 📊 Metrics</a></li><li class="chapter-item expanded affix "><li class="part-title">🧑💻 Development</li><li class="chapter-item expanded "><a href="../contributing.html"><strong aria-hidden="true">5.</strong> Contributing</a></li><li class="chapter-item expanded affix "><li class="part-title">🥼 Advanced</li><li class="chapter-item expanded "><a href="../advanced/provisioning.html" class="active"><strong aria-hidden="true">6.</strong> Provisioning</a></li><li class="chapter-item expanded "><a href="../advanced/workers.html"><strong aria-hidden="true">7.</strong> Workers</a></li><li class="chapter-item expanded "><a href="../advanced/encryption.html"><strong aria-hidden="true">8.</strong> 🔒 Encryption</a></li><li class="chapter-item expanded "><a href="../advanced/widgets.html"><strong aria-hidden="true">9.</strong> 🪀 Widgets</a></li><li class="chapter-item expanded "><a href="../advanced/service_bots.html"><strong aria-hidden="true">10.</strong> Service Bots</a></li></ol> </div>
|
|||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div id="page-wrapper" class="page-wrapper">
|
|||
|
|
|
|||
|
|
<div class="page">
|
|||
|
|
|
|||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
|||
|
|
<div class="left-buttons">
|
|||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|||
|
|
<i class="fa fa-bars"></i>
|
|||
|
|
</button>
|
|||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|||
|
|
<i class="fa fa-paint-brush"></i>
|
|||
|
|
</button>
|
|||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|||
|
|
</ul>
|
|||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|||
|
|
<i class="fa fa-search"></i>
|
|||
|
|
</button>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<h1 class="menu-title">Matrix Hookshot</h1>
|
|||
|
|
|
|||
|
|
<div class="right-buttons">
|
|||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|||
|
|
<i id="print-button" class="fa fa-print"></i>
|
|||
|
|
</a>
|
|||
|
|
<a href="https://github.com/matrix-org/matrix-hookshot" title="Git repository" aria-label="Git repository">
|
|||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|||
|
|
</a>
|
|||
|
|
<a href="https://github.com/matrix-org/matrix-hookshot/edit/main/docs/advanced/provisioning.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div id="search-wrapper" class="hidden">
|
|||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|||
|
|
</form>
|
|||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|||
|
|
<ul id="searchresults">
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<div id="content" class="content">
|
|||
|
|
<main>
|
|||
|
|
<h1 id="provisioning"><a class="header" href="#provisioning">Provisioning</a></h1>
|
|||
|
|
<p>This section is not complete yet for end users. For developers, you can read the documentation for the API below:</p>
|
|||
|
|
<h2 id="provisioning-api-for-matrix-hookshot"><a class="header" href="#provisioning-api-for-matrix-hookshot">Provisioning API for matrix-hookshot</a></h2>
|
|||
|
|
<h1 id="overview"><a class="header" href="#overview">Overview</a></h1>
|
|||
|
|
<p>This document describes how to integrate with <code>matrix-hookshot</code>'s provisioning API.</p>
|
|||
|
|
<p>Requests made to the bridge must be against the API listener defined in the config under <code>provisioning</code>, not
|
|||
|
|
the appservice or webhook listeners.</p>
|
|||
|
|
<p>Requests should always be authenticated with the secret given in the config, inside the <code>Authorization</code> header.
|
|||
|
|
Requests being made on behalf of users (most provisioning APIs) should include the userId as a query parameter.</p>
|
|||
|
|
<pre><code>GET /v1/health?userId=%40Half-Shot%3Ahalf-shot.uk
|
|||
|
|
Authorization: Bearer secret
|
|||
|
|
</code></pre>
|
|||
|
|
<p>APIs are versioned independently so two endpoints on the latest version may not always have the same version.</p>
|
|||
|
|
<h1 id="apis"><a class="header" href="#apis">APIs</a></h1>
|
|||
|
|
<h2 id="get-v1health"><a class="header" href="#get-v1health">GET /v1/health</a></h2>
|
|||
|
|
<p>Request the status of the provisioning API.</p>
|
|||
|
|
<h3 id="response"><a class="header" href="#response">Response</a></h3>
|
|||
|
|
<pre><code>HTTP 200
|
|||
|
|
{}
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Any other response should be considered a failed request (e.g. 404, 502 etc).</p>
|
|||
|
|
<h2 id="get-v1connectiontypes"><a class="header" href="#get-v1connectiontypes">GET /v1/connectiontypes</a></h2>
|
|||
|
|
<p>Request the connection types enabled for this bridge.</p>
|
|||
|
|
<h3 id="response-1"><a class="header" href="#response-1">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"JiraProject": {
|
|||
|
|
"type": "JiraProject", // The name of the connection
|
|||
|
|
"eventType": "uk.half-shot.matrix-hookshot.jira.project", // Corresponds to the state type for the connection
|
|||
|
|
"service": "jira", // or github, webhook. A human-readable service name to make things look pretty
|
|||
|
|
"botUserId": "@hookshot:yourdomain.com", // The bot mxid for the service. Currently, this is the sender_localpart, but may change in the future.
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="get-v1roomidconnections"><a class="header" href="#get-v1roomidconnections">GET /v1/{roomId}/connections</a></h2>
|
|||
|
|
<p>Request the connections for a given room. The <code>{roomId}</code> parameter is the target Matrix room.</p>
|
|||
|
|
<h3 id="response-2"><a class="header" href="#response-2">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">[{
|
|||
|
|
"type": "JiraProject", // The name of the connection
|
|||
|
|
"eventType": "uk.half-shot.matrix-hookshot.jira.project", // Corresponds to the state type in the connection
|
|||
|
|
"id": "opaque-unique-id", // An opaque ID used to refer to this connection. Should **NOT** be assumed to be stable.
|
|||
|
|
"service": "jira", // or github, webhook. A human-readable service name to make things look pretty
|
|||
|
|
"botUserId": "@hookshot:yourdomain.com", // The bot mxid for the service. Currently, this is the sender_localpart, but may change in the future.
|
|||
|
|
"config": {
|
|||
|
|
// ... connection specific details, can be configured.
|
|||
|
|
}
|
|||
|
|
}]
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="get-v1roomidconnectionsid"><a class="header" href="#get-v1roomidconnectionsid">GET /v1/{roomId}/connections/{id}</a></h2>
|
|||
|
|
<p>Request details of a single connection. The <code>{roomId}</code> parameter is the target Matrix room.</p>
|
|||
|
|
<h3 id="response-3"><a class="header" href="#response-3">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"type": "JiraProject", // The name of the connection
|
|||
|
|
"eventType": "uk.half-shot.matrix-hookshot.jira.project", // Corresponds to the state type in the connection
|
|||
|
|
"id": "opaque-unique-id", // An opaque ID used to refer to this connection. Should **NOT** be assumed to be stable.
|
|||
|
|
"service": "jira", // or github, webhook. A human-readable service name to make things look pretty
|
|||
|
|
"botUserId": "@hookshot:yourdomain.com", // The bot mxid for the service. Currently, this is the sender_localpart, but may change in the future.
|
|||
|
|
"config": {
|
|||
|
|
// ... connection specific details, can be configured.
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="put-v1roomidconnectionstype"><a class="header" href="#put-v1roomidconnectionstype">PUT /v1/{roomId}/connections/{type}</a></h2>
|
|||
|
|
<p>Create a new connection of a given type. The type refers to the <code>eventType</code> (<code>IConnection.CanonicalEventType</code>). The <code>{roomId}</code> parameter is the target Matrix room.</p>
|
|||
|
|
<p>The body of the request is the configuration for the connection, which will be the "ConnectionState" interface for each connection.</p>
|
|||
|
|
<h3 id="request-body"><a class="header" href="#request-body">Request body</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
// ... connection specific details, can be configured.
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="response-4"><a class="header" href="#response-4">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"type": "JiraProject", // The name of the connection
|
|||
|
|
"eventType": "uk.half-shot.matrix-hookshot.jira.project", // Corresponds to the state type in the connection
|
|||
|
|
"id": "opaque-unique-id", // An opaque ID used to refer to this connection. Should **NOT** be assumed to be stable.
|
|||
|
|
"service": "jira", // or github, webhook. A human-readable service name to make things look pretty
|
|||
|
|
"botUserId": "@hookshot:yourdomain.com", // The bot mxid for the service. Currently, this is the sender_localpart, but may change in the future.
|
|||
|
|
"config": {
|
|||
|
|
// ... connection specific details, can be configured.
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="patch-v1roomidconnectionsid"><a class="header" href="#patch-v1roomidconnectionsid">PATCH /v1/{roomId}/connections/{id}</a></h2>
|
|||
|
|
<p>Update a connection's configuration. The <code>id</code> refers to the <code>id</code> returned in the GET response.</p>
|
|||
|
|
<p>The body of the request is the configuration for the connection, which will be the "ConnectionState" interface for each connection.</p>
|
|||
|
|
<h3 id="request-body-1"><a class="header" href="#request-body-1">Request body</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
// ... connection specific details, can be configured.
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="response-5"><a class="header" href="#response-5">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
|
|||
|
|
"type": "JiraProject", // The name of the connection
|
|||
|
|
"eventType": "uk.half-shot.matrix-hookshot.jira.project", // Corresponds to the state type in the connection
|
|||
|
|
"id": "opaque-unique-id", // An opaque ID used to refer to this connection. Should **NOT** be assumed to be stable.
|
|||
|
|
"service": "jira", // or github, webhook. A human-readable service name to make things look pretty
|
|||
|
|
"botUserId": "@hookshot:yourdomain.com", // The bot mxid for the service. Currently, this is the sender_localpart, but may change in the future.
|
|||
|
|
"config": {
|
|||
|
|
// ... connection specific details, can be configured.
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="delete-v1roomidconnectionsid"><a class="header" href="#delete-v1roomidconnectionsid">DELETE /v1/{roomId}/connections/{id}</a></h2>
|
|||
|
|
<p>Delete a connection. The <code>id</code> refers to the <code>id</code> returned in the GET response.</p>
|
|||
|
|
<h3 id="response-6"><a class="header" href="#response-6">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"ok": true
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h1 id="service-specific-apis"><a class="header" href="#service-specific-apis">Service specific APIs</a></h1>
|
|||
|
|
<p>Some services have specific APIs for additional functionality, like OAuth.</p>
|
|||
|
|
<h2 id="github"><a class="header" href="#github">GitHub</a></h2>
|
|||
|
|
<h3 id="get-v1githuboauthuseriduserid"><a class="header" href="#get-v1githuboauthuseriduserid">GET /v1/github/oauth?userId={userId}</a></h3>
|
|||
|
|
<p>Request an OAuth url for the given user. Once the user has completed the steps in the OAuth process,
|
|||
|
|
the bridge will be granted access.</p>
|
|||
|
|
<h3 id="response-7"><a class="header" href="#response-7">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">[{
|
|||
|
|
"user_url": "https://github.com/login/oauth/authorize?...",
|
|||
|
|
"org_url": "https://github.com/apps/matrix-bridge/installations/new",
|
|||
|
|
}]
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="get-v1githubaccountuseriduserid"><a class="header" href="#get-v1githubaccountuseriduserid">GET /v1/github/account?userId={userId}</a></h3>
|
|||
|
|
<p>Request the status of the users account. This will return a <code>loggedIn</code> value to determine if the
|
|||
|
|
bridge has a GitHub identity stored for the user, and any organisations they have access to.</p>
|
|||
|
|
<h3 id="response-8"><a class="header" href="#response-8">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"loggedIn": true,
|
|||
|
|
"organisations":[{
|
|||
|
|
"name": "half-shot",
|
|||
|
|
"avatarUrl": "https://avatars.githubusercontent.com/u/8418310?v=4"
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="get-v1githuborgsorgnamerepositoriesuseriduseridpagepageperpageperpage"><a class="header" href="#get-v1githuborgsorgnamerepositoriesuseriduseridpagepageperpageperpage">GET /v1/github/orgs/{orgName}/repositories?userId={userId}&page={page}&perPage={perPage}</a></h3>
|
|||
|
|
<p>Request a list of all repositories a user is a member of in the given org. The <code>owner</code> and <code>name</code> value of a repository can be given to create a new GitHub connection.</p>
|
|||
|
|
<p>This request is paginated, and <code>page</code> sets the page (defaults to <code>1</code>) while <code>perPage</code> (defaults to <code>10</code>) sets the number of entries per page.</p>
|
|||
|
|
<p>This request can be retried until the number of entries is less than the value of <code>perPage</code>.</p>
|
|||
|
|
<h3 id="response-9"><a class="header" href="#response-9">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"loggedIn": true,
|
|||
|
|
"repositories":[{
|
|||
|
|
"name": "matrix-hookshot",
|
|||
|
|
"owner": "matrix-org",
|
|||
|
|
"fullName": "matrix-org/matrix-hookshot",
|
|||
|
|
"avatarUrl": "https://avatars.githubusercontent.com/u/8418310?v=4",
|
|||
|
|
"description": "A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA. "
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="get-v1githubrepositoriesuseriduseridpagepageperpageperpage"><a class="header" href="#get-v1githubrepositoriesuseriduseridpagepageperpageperpage">GET /v1/github/repositories?userId={userId}&page={page}&perPage={perPage}</a></h3>
|
|||
|
|
<p>Request a list of all repositories a user is a member of (including those not belonging to an org). The <code>owner</code> and <code>name</code> value of a repository can be given to create a new GitHub connection.</p>
|
|||
|
|
<p>If the user has only allowed a subset of repositories to be bridged, <code>changeSelectionUrl</code> will be defined and can be used to expand the search query.</p>
|
|||
|
|
<p>This request is paginated, and <code>page</code> sets the page (defaults to <code>1</code>) while <code>perPage</code> (defaults to <code>10</code>) sets the number of entries per page.</p>
|
|||
|
|
<p>This request can be retried until the number of entries is less than the value of <code>perPage</code>.</p>
|
|||
|
|
<h3 id="response-10"><a class="header" href="#response-10">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"loggedIn": true,
|
|||
|
|
"changeSelectionUrl": "https://github.com/settings/installations/12345",
|
|||
|
|
"repositories":[{
|
|||
|
|
"name": "matrix-hookshot",
|
|||
|
|
"owner": "matrix-org",
|
|||
|
|
"fullName": "matrix-org/matrix-hookshot",
|
|||
|
|
"avatarUrl": "https://avatars.githubusercontent.com/u/8418310?v=4",
|
|||
|
|
"description": "A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA. "
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h2 id="jira"><a class="header" href="#jira">JIRA</a></h2>
|
|||
|
|
<h3 id="get-v1jiraoauthuseriduserid"><a class="header" href="#get-v1jiraoauthuseriduserid">GET /v1/jira/oauth?userId={userId}</a></h3>
|
|||
|
|
<p>Request an OAuth url for the given user. Once the user has completed the steps in the OAuth process,
|
|||
|
|
the bridge will be granted access.</p>
|
|||
|
|
<h3 id="response-11"><a class="header" href="#response-11">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"url": "https://auth.atlassian.com/authorize?..."
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="get-v1jiraaccountuseriduserid"><a class="header" href="#get-v1jiraaccountuseriduserid">GET /v1/jira/account?userId={userId}</a></h3>
|
|||
|
|
<p>Request the status of the users account. This will return a <code>loggedIn</code> value to determine if the
|
|||
|
|
bridge has a JIRA identity stored for the user, and any instances they have access to. Note that if a
|
|||
|
|
user does not have access to an instance, they can authenticate again to gain access to it (if they are able
|
|||
|
|
to consent).</p>
|
|||
|
|
<h3 id="response-12"><a class="header" href="#response-12">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">{
|
|||
|
|
"loggedIn": true,
|
|||
|
|
"instances":[{
|
|||
|
|
"name": "acme",
|
|||
|
|
"url": "https://acme.atlassian.net"
|
|||
|
|
}]
|
|||
|
|
}
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="get-v1jirainstancesinstancenameprojectsuseriduserid"><a class="header" href="#get-v1jirainstancesinstancenameprojectsuseriduserid">GET /v1/jira/instances/{instanceName}/projects?userId={userId}</a></h3>
|
|||
|
|
<p>Request a list of all projects a user can see in a given instance. The <code>url</code> value of a project can be given to create
|
|||
|
|
a new JIRA connection.</p>
|
|||
|
|
<h3 id="response-13"><a class="header" href="#response-13">Response</a></h3>
|
|||
|
|
<pre><code class="language-json5">[{
|
|||
|
|
"key": "PLAY",
|
|||
|
|
"name": "Jira Playground",
|
|||
|
|
"url": "https://acme.atlassian.net/projects/PLAY"
|
|||
|
|
}]
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
</main>
|
|||
|
|
|
|||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|||
|
|
<!-- Mobile navigation buttons -->
|
|||
|
|
<a rel="prev" href="../contributing.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|||
|
|
<i class="fa fa-angle-left"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<a rel="next" href="../advanced/workers.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|||
|
|
<i class="fa fa-angle-right"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<div style="clear: both"></div>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|||
|
|
<a rel="prev" href="../contributing.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|||
|
|
<i class="fa fa-angle-left"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<a rel="next" href="../advanced/workers.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|||
|
|
<i class="fa fa-angle-right"></i>
|
|||
|
|
</a>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
window.playground_copyable = true;
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
|||
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
|||
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
|||
|
|
|
|||
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
|||
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
|||
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
|||
|
|
|
|||
|
|
<!-- Custom JS scripts -->
|
|||
|
|
<script type="text/javascript" src="../docs/_site/main.js"></script>
|
|||
|
|
<script type="text/javascript" src="../docs/_site/version.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|