Connect API

Connect API Reference - Operator API

Authentication Specification

Overview

Implement an authentication mechanism using clientKey and clientSecret to obtain a valid JWT token.

Requirements

  • Credentials:

    • clientKey: A unique identifier for the client.

    • clientSecret: A secret associated with the clientKey used for verification.

    Security Considerations

    • Ensure clientSecret is stored securely and transmitted over HTTPS.

    • Implement rate limiting to protect against brute force attacks.


Authenticates the client using the provided credentials.

post

This endpoint is used to authenticate clients by validating their credentials (key and secret). On success, an access token and a refresh token are returned. These tokens are used for authorized access to the protected API endpoints.

Authorizations
AuthorizationstringRequired

REQUIRED - JWT Authorization header using the Bearer scheme. All API endpoints require authentication, except for authentication endpoints (Connect/authentication). Example: "Authorization: Bearer {token}"

Query parameters
api-versionstringOptional
Body
clientKeystring | nullableOptional
clientSecretstring | nullableOptional
Responses
200

Authentication was successful. The response includes the access and refresh tokens.

post
/Connect/authentication

Last updated