Oauth Connections
SDK methods for the Oauth Connections module, accessed via soat.oauthConnections. See the Oauth Connections module docs for permissions and data model, and each method's REST page for the full request/response schema.
soat.oauthConnections.listOauthConnections()
List OAuth connections
- Method:
GET - Path:
/api/v1/oauth-connections
await soat.oauthConnections.listOauthConnections({
query: { /* + optional */ },
});
soat.oauthConnections.createOauthConnection()
Start an OAuth connection
- Method:
POST - Path:
/api/v1/oauth-connections
await soat.oauthConnections.createOauthConnection({
body: { oauth_client_id, actor_id, /* + optional */ },
});
soat.oauthConnections.completeOauthConnection()
Complete an OAuth connection
- Method:
GET - Path:
/api/v1/oauth-connections/callback
await soat.oauthConnections.completeOauthConnection({
query: { /* + optional */ },
});
soat.oauthConnections.getOauthConnection()
Get an OAuth connection
- Method:
GET - Path:
/api/v1/oauth-connections/{oauth_connection_id}
await soat.oauthConnections.getOauthConnection();
soat.oauthConnections.deleteOauthConnection()
Delete an OAuth connection
- Method:
DELETE - Path:
/api/v1/oauth-connections/{oauth_connection_id}
await soat.oauthConnections.deleteOauthConnection();