auth_endpoints

Authorize with OAuth 2.0

Request a user's authorization to perform action on their behalf

get/v1/auth/oauth2/authorize

Request

Base URL
https://partners.tryotter.com
Auth
none required
TypeScript
https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/auth/oauth2/authorize/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

client_idstring required

The ID of the client (also known as the Application ID).

redirect_uristring required

The URI to where the user should be redirected when the flow is successfully completed. It must be previously registered at Otter Developer Portal in the application settings.

response_typestring required

Specifies the expected response type. Only "code" is accepted.

scopestring required

The scope to request, multiple scopes are passed delimited by a space character.

statestring required

Can be used to store request-specific data. The server will return the unmodified state value back to the application.

code_challengestring

A code verifier generated by the client application transformed by applying a cryptographic hash function, such as SHA-256, and encoding the result using URL-safe Base64 encoding.

code_challenge_methodstring

Method used to transform the code verifier. The most common method is "S256", which stands for SHA-256.

Changes

No recorded changes to this operation across all 1 revision of this API.