Openlane OpenAPI 3.1.1 Specifications
Openlane's API services are designed to provide a simple and easy to use interface for interacting with the Openlane platform. This API is designed to be used by both internal and external clients to interact with the Openlane platform.
Authentication
- HTTP: Bearer Auth
- API Key: apiKey
- HTTP: Basic Auth
- HTTP: Bearer Auth
- OAuth 2.0: oauth2
Bearer token authentication using API tokens. The token identifies the organization and grants permissions to manage users and groups within that organization's scope.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
API Key authentication, the key must be a valid API key
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Username and Password based authentication
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | basic |
Bearer authentication, the token must be a valid API token
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
OAuth 2.0 authorization code flow for secure API access
Security Scheme Type: | oauth2 |
|---|---|
OAuth Flow (authorizationCode): | Token URL: https://api.theopenlane.io/oauth2/token Authorization URL: https://api.theopenlane.io/oauth2/authorize Refresh URL: https://api.theopenlane.io/oauth2/refresh Scopes:
|
License
Apache 2.0