v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

Retrieve an OAuth Connection

get/oauth_connections/{oauth_connection_id}

Path parameters

oauth_connection_idstring required

The identifier of the OAuth Connection.

Response

OAuth Connection

created_atstring date-time required

The ISO 8601 timestamp when the OAuth Connection was created.

deleted_atstring date-time nullable required

The ISO 8601 timestamp when the OAuth Connection was deleted.

group_idstring required

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

idstring required

The OAuth Connection's identifier.

oauth_application_idstring required

The identifier of the OAuth application this connection is for.

status'active' | 'inactive' required

Whether the connection is active.

type'oauth_connection' required

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

Example response

{
  "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"
}