Skip to main content

Oauth Connections Commands

See Oauth Connections module docs for permissions and data model.

soat list-oauth-connections​

List OAuth connections

  • Method: GET
  • Path: /api/v1/oauth-connections

Usage​

soat list-oauth-connections

Options​

--project-id​

Project ID (required if not using project key auth)

  • Source: query
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--actor-id​

Only this actor's connections

  • Source: query
  • Required: no
  • Type: string
  • Example: actor_V1StGXR8Z5jdHi6B
--oauth-client-id​

Only connections through this OAuth client

  • Source: query
  • Required: no
  • Type: string
  • Example: oauc_V1StGXR8Z5jdHi6B

soat create-oauth-connection​

Start an OAuth connection

  • Method: POST
  • Path: /api/v1/oauth-connections

Usage​

soat create-oauth-connection --oauth-client-id <string> --actor-id <string>

Options​

--oauth-client-id​

The OAuth client to connect through.

  • Source: body
  • Required: yes
  • Type: string
  • Example: oauc_V1StGXR8Z5jdHi6B
--actor-id​

The actor the grant is for.

  • Source: body
  • Required: yes
  • Type: string
  • Example: actor_V1StGXR8Z5jdHi6B
--return-url​

Where the callback redirects the person's browser when it completes, with oauth_connection_id and status (connected or failed) added to its query.

  • Source: body
  • Required: no
  • Type: string
  • Example: https://app.example.com/settings/connections

soat complete-oauth-connection​

Complete an OAuth connection

  • Method: GET
  • Path: /api/v1/oauth-connections/callback

Usage​

soat complete-oauth-connection

Options​

--state​

The state of the authorize URL

  • Source: query
  • Required: no
  • Type: string
--code​

The authorization code

  • Source: query
  • Required: no
  • Type: string
--error​

The provider's refusal, such as access_denied

  • Source: query
  • Required: no
  • Type: string
--error-description​

The provider's refusal, in words

  • Source: query
  • Required: no
  • Type: string
--error-uri​

Sent by some providers with a refusal; ignored

  • Source: query
  • Required: no
  • Type: string
--scope​

Sent by some providers; ignored

  • Source: query
  • Required: no
  • Type: string
--iss​

Sent by some providers (RFC 9207); ignored

  • Source: query
  • Required: no
  • Type: string

soat get-oauth-connection​

Get an OAuth connection

  • Method: GET
  • Path: /api/v1/oauth-connections/{oauth_connection_id}

Usage​

soat get-oauth-connection

Options​

This command has no options.

soat delete-oauth-connection​

Delete an OAuth connection

  • Method: DELETE
  • Path: /api/v1/oauth-connections/{oauth_connection_id}

Usage​

soat delete-oauth-connection

Options​

This command has no options.