OAuth Connections

When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth here.

The OAuth Connection object

{
  "created_at": "2020-01-31T23:59:59Z",
  "deleted_at": null,
  "group_id": "group_1g4mhziu6kvrs3vz35um",
  "id": "connection_dauknoksyr4wilz4e6my",
  "oauth_application_id": "application_gj9ufmpgh5i56k4vyriy",
  "status": "active",
  "type": "oauth_connection"
}

Attributes

created_at

string

The ISO 8601 timestamp when the OAuth Connection was created.

deleted_at

string

Nullable

The ISO 8601 timestamp when the OAuth Connection was deleted.

group_id

string

The identifier of the Group that has authorized your OAuth application.

More about Groups.

string

The OAuth Connection’s identifier.

oauth_application_id

string

The identifier of the OAuth application this connection is for.

More about OAuth Applications.

status

enum

Whether the connection is active.

type

string

A constant representing the object’s type. For this resource it will always be oauth_connection.

List OAuth Connections

curl \
  --url "${INCREASE_URL}/oauth_connections" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* OAuth Connection object */ },
    { /* OAuth Connection object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

status.in

array of strings

Filter to OAuth Connections by their status. By default, return only the active ones. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

oauth_application_id

string

Filter results to only include OAuth Connections for a specific OAuth Application.

More about OAuth Applications.

cursor

string

limit

integer

Retrieve an OAuth Connection

curl \
  --url "${INCREASE_URL}/oauth_connections/connection_dauknoksyr4wilz4e6my" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

oauth_connection_id

string

Required

The identifier of the OAuth Connection.

Between 1 and 200 characters