Add authentication with OAuth2

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2

OAuth2

Activate OAuth2 authentication for webhooks.

Path parameters

platform-code string Required

The unique code assigned to the reservation platform.

Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

application/json

Body

The OAuth2 credentials that will be sent with the webhook notifications. See OAuth 2.0.

clientId string Required

The OAuth2 client ID.
clientSecret string(password) Required

The OAuth2 client secret.
clientName string

The OAuth2 client name.
clientAuthorizationMethod string

The client authorization method. See OAuth2 Client Authentication.

Values are CLIENT_SECRET_BASIC, CLIENT_SECRET_JWT, or CLIENT_SECRET_POST. Default value is CLIENT_SECRET_BASIC.
authorizationGrantType string

The authorization grant type. See OAuth2 Grant Types.

Value is CLIENT_CREDENTIALS. Default value is CLIENT_CREDENTIALS.
scopes array[string]

The scopes being granted to the API client.
providerTokenUri string(uri) Required

The external platform URL for getting access tokens by private credentials.
providerJwkSetUri string(uri)

The external platform URL for getting public keys to verify given access tokens on the K-Series side.

Responses

200

Accepted
400

Non relevant request
403

Scope 'reservation-{platform-code}' not found in the token
404

Platform not found

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2

curl \
 -X PATCH https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/webhook/auth/oauth2 \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"clientId":"LightspeedKSeries","clientSecret":"Example-Client-Secret","clientName":"LightspeedKSeries","clientAuthorizationMethod":"CLIENT_SECRET_BASIC","authorizationGrantType":"CLIENT_CREDENTIALS","scopes":["webhooks-api"],"providerTokenUri":"https://my.platform/emitter/token","providerJwkSetUri":"https://my.platform/public-keys"}'

Request examples

{
  "clientId": "LightspeedKSeries",
  "clientSecret": "Example-Client-Secret",
  "clientName": "LightspeedKSeries",
  "clientAuthorizationMethod": "CLIENT_SECRET_BASIC",
  "authorizationGrantType": "CLIENT_CREDENTIALS",
  "scopes": [
    "webhooks-api"
  ],
  "providerTokenUri": "https://my.platform/emitter/token",
  "providerJwkSetUri": "https://my.platform/public-keys"
}