Skip to content
Kindgi

List the apps this server can connect to

View as Markdown
GET
/v1/connection-entries
curl --request GET \
  --url https://example.com/v1/connection-entries \
  --header 'Authorization: Bearer <token>'

Each app with who may own a connection to it, how a person signs in, the permissions a tool may ask for (in plain words, and whether each changes anything) and the guide an admin follows to register the app. Any signed-in member. Mounted when the deployment supplies a ConnectionBinding.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The apps.

Media typeapplication/json
object
data
required
Array<object>

An app this server can connect to.

object
id
required

The entry id: 'google', 'github'.

string
name
required

The app’s name as people know it.

string
owners
required

Who may own a connection to this app.

Array<string>
Allowed values: member company
signIn
required

How a person signs in at the app.

object
kind
required
string
Allowed values: oauth2 github-app
tenant

Present when the sign-in happens in a directory of the app’s own (Microsoft’s tenant, not a Kindgi workspace). A registration’s oauth2.tenant names it; without default, each registration must give its own.

object
default

The directory a registration that names none signs in at.

string
permissions
required

What a tool may ask for, by permission key (gmail.send).

object
key
additional properties
object
says
required

In plain words, for the person asked.

string
changes
required

Whether it changes anything at the app. false is read only.

boolean
removal

How a disconnect withdraws access at the app, and how the app reports a removal made there. {} when the app has neither: a disconnect then withdraws nothing at the app, and a removal made there is not reported.

object
revoke

How a disconnect withdraws access at the app: an OAuth revoke, or revoking the GitHub App’s installation tokens (the app stays installed).

string
Allowed values: oauth2-revoke github-installation-token
revokeIsGrantWide

Whether the app’s revoke withdraws everything the person granted the registration, not only this connection’s permissions. Google’s does.

boolean
notices

How the app reports a removal made at the app.

string
Allowed values: google-risc github-webhooks
setupGuide
required

The docs page an admin follows to register the app.

string
Example
{
  "data": [
    {
      "owners": [
        "member"
      ],
      "signIn": {
        "kind": "oauth2"
      },
      "removal": {
        "revoke": "oauth2-revoke",
        "notices": "google-risc"
      }
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also