Get Teams Integration Setup

GET

/org/:org_id/project/:project_id/integration/:integration_id/teams/setup

GET

/api/v1/org/:org_id/project/:project_id/integration/:integration_id/teams/setup

$ curl https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/integration/integration_id/teams/setup \
>      -H "Authorization: Bearer <token>"

1 {
2   "teams_install_url": "https://teams.microsoft.com/l/app/8b1f4c62-9d3a-4e57-b8a1-0c72f5d6e394?tenantId=3f2504e0-4f89-41d3-9a0c-0305e82c3301",
3   "auth_state": "connected",
4   "auth_state_reason": null,
5   "linked_installations": [
6     {
7       "id": "019a5f1d-6ea4-7d27-a18b-7f40ad5e9163",
8       "tenant_id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
9       "team_id": "19:[email protected]",
10       "status": "active",
11       "created": "2024-01-16T13:33:25.247662Z",
12       "modified": "2024-01-16T13:41:07.512883Z",
13       "project_integration_id": "019a5f1d-7fb5-7d28-a29c-8051be6fa274",
14       "team_name": "Meridian Freight Operations"
15     }
16   ]
17 }

Return everything a Teams tab needs to finish connecting this integration: the deep link that installs the Rightbrain Teams app, the integration’s authorization state, and the Teams installations already linked to it.

auth_state is connected once an installation is linked and reauth_required otherwise, in which case auth_state_reason is teams_installation_required. Both are null until the integration has a default auth principal at all.

Answers 422 when integration_id names an integration that is not of type teams, and 503 when the Teams app id is not configured on this deployment.

Return everything a Teams tab needs to finish connecting this integration: the deep link that installs the Rightbrain Teams app, the integration's authorization state, and the Teams installations already linked to it. `auth_state` is `connected` once an installation is linked and `reauth_required` otherwise, in which case `auth_state_reason` is `teams_installation_required`. Both are null until the integration has a default auth principal at all. Answers 422 when `integration_id` names an integration that is not of type `teams`, and 503 when the Teams app id is not configured on this deployment.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

integration_idstringRequiredformat: "uuid"

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Response

Teams integration setup details retrieved successfully

teams_install_urlstring

auth_statestring or nullOptional

auth_state_reasonstring or nullOptional

linked_installationslist of objectsOptional

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error