Create connector instance
Changed onCreate a connector instance from a registry type.<br><br> <b>Body:</b><br> Put the auth fields the registry schema lists for <code>authType</code> in <code>config.auth</code>, flat, and the connector's own sync settings in <code>config.sync</code>. A connector that needs no OAuth sign-in is configured on creation.<br><br> <b>OAuth:</b><br> An admin may send the OAuth app's credentials in <code>config.auth</code>: the app is saved and linked. Anyone may send <code>config.auth.oauthConfigId</code> to use a saved app; non-admins must. Send <code>baseUrl</code>: the provider redirects to <code>{baseUrl}/{redirectUri}</code>.<br><br> <b>Scope Permissions:</b><br>
<ul> <li><code>team</code> scope requires admin privileges</li> <li><code>personal</code> scope available to all users</li> </ul> <b>Next Steps After Creation:</b><br> <ol> <li>OAuth only: <code>GET /{id}/oauth/authorize</code>, then <code>GET /oauth/callback</code></li> <li>Optionally set sync and filters via <code>PUT /{id}/config/filters-sync</code></li> <li>Turn sync on via <code>POST /{id}/toggle</code></li> </ol>Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/connectors
- Auth
- HTTP bearer
- or OAuth 2Authorization code: /api/v1/oauth2/authorizeClient credentialsToken URL: /api/v1/oauth2/token scopes: connector:write
Request body
Example request
{
"scope": "team",
"config": {
"auth": {
"baseUrl": "https://mycompany.atlassian.net",
"email": "admin@mycompany.com",
"apiToken": "ATATT3x..."
}
}
}Response
Connector instance created. It is not syncing yet.
Example response
{
"connector": {
"connectorId": "7b387394-1248-4fb6-810d-e8ac9ac226eb",
"scope": "team"
},
"message": "Connector instance created successfully."
}Changes
- breaking
added the pattern
\Sto the request property - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
/// - info
the
request property format was generalized fromurito no format
- breaking
- info
added the new
ENTRA_IDenum value to the request property//// - info
added the new
IAM_ROLEenum value to the request property////
- info