Skip to Content
kosemdocs
ReferenceAPIConnections

List connections in project

Lists the connections of an organization, or a project's own, or, as the project - with a filter that names an organization, those of the organization's projects that the caller holds connections.connections.list on.

GET
/v1/projects/{project}/connections

Lists the connections of an organization, or a project's own, or, as the project - with a filter that names an organization, those of the organization's projects that the caller holds connections.connections.list on.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

project*string

The project's ID, or - for every project of the organization that filter names.

Match^(-|prj_[0-7][0-9a-hjkmnp-tv-z]{25})$

Query Parameters

pageSize?integer

Maximum number of connections to return. Defaults to 50; values above 500 are treated as 500.

Formatint32
Range0 <= value
pageToken?string

Page token from a previous response.

filter?string

With the project -, and only then: organization = "organizations/{organization_id}". The list then holds the connections of every project of the organization that the caller holds connections.connections.list on, without the organization's own.

Lengthlength <= 200

Response Body

OK

application/json
  1. response
connections*array<>

Connections, oldest first.

nextPageToken*string

Token for the next page; empty on the last page.

Example Request
curl -X GET 'https://api.kosem.ai/v1/projects/string/connections'
Example Response
{
  "connections": [
    {
      "availability": {
        "allProjects": true,
        "projects": [
          "string"
        ]
      },
      "config": {
        "property1": "string",
        "property2": "string"
      },
      "createTime": "2019-08-24T14:15:22Z",
      "displayName": "string",
      "name": "string",
      "roles": [
        {
          "arn": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "default": true,
          "displayName": "string",
          "name": "string",
          "state": "ACTIVE",
          "stateReason": "string",
          "verifyTime": "2019-08-24T14:15:22Z"
        }
      ],
      "serviceAccounts": [
        {
          "createTime": "2019-08-24T14:15:22Z",
          "default": true,
          "displayName": "string",
          "email": "string",
          "state": "ACTIVE",
          "stateReason": "string",
          "verifyTime": "2019-08-24T14:15:22Z"
        }
      ],
      "state": "ACTIVE",
      "stateReason": "string",
      "trust": {
        "attributeCondition": "string",
        "audience": "string",
        "issuer": "string",
        "subject": "string"
      },
      "type": "string",
      "updateTime": "2019-08-24T14:15:22Z",
      "verifyTime": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string"
}