Sign inGet started
API

List an Identity's Connectors

GET
/api/identities/{handle}/connectors

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.tigby.eu/api/identities/string/connectors"
{  "connectors": [    {      "platform": "string",      "status": "string",      "account": "string",      "account_id": "string",      "service": "string",      "connected_via": "string",      "capabilities": [        "string"      ],      "disclosed": true,      "paused": true,      "polled_at": null,      "last_error": null,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "paused": true}

Stop or restart every Connector of an Identity

PATCH
/api/identities/{handle}/connectors

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://api.tigby.eu/api/identities/string/connectors" \  -H "Content-Type: application/json" \  -d '{    "paused": null  }'
{  "connectors": [    {      "platform": "string",      "status": "string",      "account": "string",      "account_id": "string",      "service": "string",      "connected_via": "string",      "capabilities": [        "string"      ],      "disclosed": true,      "paused": true,      "polled_at": null,      "last_error": null,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "paused": true}

One Connector

GET
/api/identities/{handle}/connectors/{platform}

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.tigby.eu/api/identities/string/connectors/string"
{  "platform": "string",  "status": "string",  "account": "string",  "account_id": "string",  "service": "string",  "connected_via": "string",  "capabilities": [    "string"  ],  "disclosed": true,  "paused": true,  "polled_at": null,  "last_error": null,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Stop or restart one Connector

PATCH
/api/identities/{handle}/connectors/{platform}

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://api.tigby.eu/api/identities/string/connectors/string" \  -H "Content-Type: application/json" \  -d '{    "paused": null  }'
{  "platform": "string",  "status": "string",  "account": "string",  "account_id": "string",  "service": "string",  "connected_via": "string",  "capabilities": [    "string"  ],  "disclosed": true,  "paused": true,  "polled_at": null,  "last_error": null,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Disconnect an account

DELETE
/api/identities/{handle}/connectors/{platform}

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Response Body

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://api.tigby.eu/api/identities/string/connectors/string"
Empty

Connect an account with an app password

PUT
/api/identities/{handle}/connectors/{platform}

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PUT "https://api.tigby.eu/api/identities/string/connectors/string" \  -H "Content-Type: application/json" \  -d '{    "account": null,    "app_password": null,    "apply_disclosure": null  }'
{  "platform": "string",  "status": "string",  "account": "string",  "account_id": "string",  "service": "string",  "connected_via": "string",  "capabilities": [    "string"  ],  "disclosed": true,  "paused": true,  "polled_at": null,  "last_error": null,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Start the Console OAuth connect

POST
/api/identities/{handle}/connectors/{platform}/authorize

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.tigby.eu/api/identities/string/connectors/string/authorize" \  -H "Content-Type: application/json" \  -d '{    "account": null  }'
{  "authorization_url": "string",  "state": "string",  "expires_at": "2019-08-24T14:15:22Z",  "instance_rules": [    {      "id": "string",      "text": "string",      "hint": null    }  ]}

Read the connected account's own posts

GET
/api/identities/{handle}/connectors/{platform}/posts

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Query Parameters

limit?integer
Formatint32
cursor?string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.tigby.eu/api/identities/string/connectors/string/posts"
{  "posts": [    {      "uri": "string",      "url": null,      "author_id": "string",      "author": "string",      "author_name": null,      "text": "string",      "reply_to": null,      "created_at": "2019-08-24T14:15:22Z"    }  ],  "cursor": null}

Post, or reply to a post

POST
/api/identities/{handle}/connectors/{platform}/posts

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.tigby.eu/api/identities/string/connectors/string/posts" \  -H "Content-Type: application/json" \  -d '{    "text": null,    "reply_to": null,    "options": null  }'
{  "uri": "string",  "url": null,  "author_id": "string",  "author": "string",  "author_name": null,  "text": "string",  "reply_to": null,  "created_at": "2019-08-24T14:15:22Z"}

Read the account's direct-message conversations

GET
/api/identities/{handle}/connectors/{platform}/dms

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Query Parameters

limit?integer
Formatint32
cursor?string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.tigby.eu/api/identities/string/connectors/string/dms"
{  "posts": [    {      "uri": "string",      "url": null,      "author_id": "string",      "author": "string",      "author_name": null,      "text": "string",      "reply_to": null,      "created_at": "2019-08-24T14:15:22Z"    }  ],  "cursor": null}

Send a direct message

POST
/api/identities/{handle}/connectors/{platform}/dms

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.tigby.eu/api/identities/string/connectors/string/dms" \  -H "Content-Type: application/json" \  -d '{    "to": null,    "text": null,    "reply_to": null,    "options": null  }'
{  "uri": "string",  "url": null,  "author_id": "string",  "author": "string",  "author_name": null,  "text": "string",  "reply_to": null,  "created_at": "2019-08-24T14:15:22Z"}

Read a post and what answers it

GET
/api/identities/{handle}/connectors/{platform}/thread

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Query Parameters

uri?string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.tigby.eu/api/identities/string/connectors/string/thread"
{  "posts": [    {      "uri": "string",      "url": null,      "author_id": "string",      "author": "string",      "author_name": null,      "text": "string",      "reply_to": null,      "created_at": "2019-08-24T14:15:22Z"    }  ],  "cursor": null}

Read what has happened to the connected account

GET
/api/identities/{handle}/connectors/{platform}/notifications

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Path Parameters

handle*string
platform*string

Query Parameters

limit?integer
Formatint32
cursor?string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.tigby.eu/api/identities/string/connectors/string/notifications"
{  "notifications": [    {      "kind": "string",      "post": {        "uri": "string",        "url": null,        "author_id": "string",        "author": "string",        "author_name": null,        "text": "string",        "reply_to": null,        "created_at": "2019-08-24T14:15:22Z"      },      "at": "2019-08-24T14:15:22Z"    }  ],  "cursor": null}

Finish the Console OAuth connect

POST
/api/connectors/callback

Authorization

api_key
AuthorizationBearer <token>

An Admin Key (tigby_admin_…) for Org-level calls, an Identity Key (tigby_id_…) for one Identity's own resources, or a console session (tigby_sess_…). Sent as Authorization: Bearer .

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.tigby.eu/api/connectors/callback" \  -H "Content-Type: application/json" \  -d '{    "callback": null,    "apply_disclosure": null  }'
{  "platform": "string",  "status": "string",  "account": "string",  "account_id": "string",  "service": "string",  "connected_via": "string",  "capabilities": [    "string"  ],  "disclosed": true,  "paused": true,  "polled_at": null,  "last_error": null,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

The OAuth client-metadata document

GET
/api/connectors/{platform}/client-metadata.json

Path Parameters

platform*string

Response Body

application/json

application/problem+json

curl -X GET "https://api.tigby.eu/api/connectors/string/client-metadata.json"
{}

Vault

The Org's encrypted secret store, in the Org's namespace or in one Identity's.

Exports

An archive of everything Tigby holds, for the Org or for one Identity, fetched once.