OAuth Authentication

Manage provider OAuth connection authentication information

OAuth Authentication object

Attributes

object

Object

id

String

The unique identifier for this OAuth connection profile

status

Enum

The result status of the OAuth connection attempt

error

Object

Details of any error that occurred during the connection attempt

events

Array of Objects

A list of events that occurred during the OAuth connection attempt

connection_id

String

The ID of the related OAuth connection

profile

Object

created_at

Date

Timestamp when the connection profile was created

{
  "object": "provider_oauth.connection.profile",
  "id": "example_id",
  "status": "completed",
  "error": {
    "code": "example_code",
    "message": "example_message"
  },
  "events": [
    {
      "id": "example_id",
      "type": "authentication_completed",
      "metadata": {},
      "created_at": "2025-08-12T09:45:16.293Z"
    },
    {
      "type": "authentication_completed",
      "metadata": {}
    }
  ],
  "connection_id": "example_connection_id",
  "profile": {
    "object": "provider_oauth.connection.profile",
    "id": "example_id",
    "status": "active",
    "sub": "example_sub",
    "name": "example_name",
    "email": "example_email",
    "connection_id": "example_connection_id",
    "created_at": "2025-08-12T09:45:16.293Z",
    "last_used_at": "2025-08-12T09:45:16.293Z",
    "updated_at": "2025-08-12T09:45:16.293Z"
  },
  "created_at": "2025-08-12T09:45:16.293Z"
}

List provider OAuth connection authentications

List provider OAuth connection authentications for a specific connection

URL Parameters

connectionId

String

The unique identifier for the connection

GEThttp://api.metorial.com/provider-oauth/connections/:connectionId/authentications
curl -X GET "https://api.metorial.com/provider-oauth/connections/con_Rm4Mnheq2bfEPhBhP7SY/authentications" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."

Get provider OAuth connection authentication

Get the information of a specific provider OAuth connection authentication

URL Parameters

connectionId

String

The unique identifier for the connection

authenticationId

String

The unique identifier for the authentication

GEThttp://api.metorial.com/provider-oauth/connections/:connectionId/authentications/:authenticationId
curl -X GET "https://api.metorial.com/provider-oauth/connections/con_Rm4Mnheq2bfEPhBhP7SY/authentications/aut_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..."