List connections

curl --request GET \
  --url https://api-next.ofauth.com/v2/connections \
  --header 'apiKey: <api-key>'

{
  "list": [
    {
      "status": "active",
      "id": "<string>",
      "userData": {
        "id": "<string>",
        "name": "<string>",
        "username": "<string>",
        "avatar": "<string>"
      },
      "permissions": [
        "<string>"
      ],
      "expiredAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "clientReferenceId": "<string>"
    }
  ],
  "hasMore": true
}

GET

connections

List connections

curl --request GET \
  --url https://api-next.ofauth.com/v2/connections \
  --header 'apiKey: <api-key>'

{
  "list": [
    {
      "status": "active",
      "id": "<string>",
      "userData": {
        "id": "<string>",
        "name": "<string>",
        "username": "<string>",
        "avatar": "<string>"
      },
      "permissions": [
        "<string>"
      ],
      "expiredAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "clientReferenceId": "<string>"
    }
  ],
  "hasMore": true
}

Authorizations

apiKey

string

header

required

Query Parameters

status

enum<string>

Available options:

active,

expired,

awaiting_2fa

limit

number

default:10

offset

number

default:0

Response

Connections found

list

object[]

required

Show child attributes

list.status

enum<string>

required

The status of the connection.

Available options:

active,

expired,

awaiting_2fa

list.id

string

required

The ID of the connection.

list.userData

object

required

Data could be outdated if the connection is expired, but will be updated once the account has been reconnected.

Show child attributes

list.userData.id

string

required

The ID of the user.

list.userData.name

string

required

The name of the user.

list.userData.username

string

required

The username of the user.

list.userData.avatar

string | null

required

The avatar of the user.

list.permissions

string[]

required

The permissions of the connection.

list.expiredAt

string | null

required

The expiration date of the connection.

list.createdAt

string

required

The creation date of the connection.

list.updatedAt

string

required

The last update date of the connection.

list.clientReferenceId

string | null

required

The client reference ID of the connection.

hasMore

boolean

required

Whoami

Disconnect connection

⌘I

Account

Link API

Access API

Dynamic Rules API

List connections

Authorizations

Query Parameters

Response