Start OAuth2 authorization flow

GET

/api/v1/auth/oauth2/authorize/{provider}

const url = 'http://localhost:11044/api/v1/auth/oauth2/authorize/example';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/auth/oauth2/authorize/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Redirects to the provider’s consent screen when a client app is configured. Without one, an HTML caller is redirected to the chat view to be prompted for credentials, and any other caller gets 409 with a remedy.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

provider

required

string

The provider key, as name in GET /auth/oauth2/providers — an apis.yml entry’s oauth2.provider, so one key covers every entry grouped under it (e.g. google-workspace); a key no oauth2 entry in this world declares is a 404

Responses

302

Redirect to the provider consent screen, or to the chat view when no client app is configured and the caller accepts HTML

404

No such OAuth2 provider in this world

*/*

The OAuth2 provider named in the path is not one this world declares with OAuth2 auth

object

error

required

Why, naming the provider asked for

string

409

No client app configured for the provider (non-HTML caller)

*/*

The provider is declared, but no OAuth2 client app is configured for it, so there is no consent screen to send the caller to

object

error

required

Why, naming the provider

string

provider

required

The provider asked for

string

remedy

required

What an operator does to make the provider connectable

string