Add documentation: Authentication and Authorization #23
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![quantstruct-dev-newman[bot]](https://app.smartcontext.ai/default/https://avatars.githubusercontent.com/u/87218623?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Authentication and Authorization
This document provides a comprehensive guide to authentication and authorization methods used to securely access our API. It is intended for developers and security engineers who need to integrate with our platform. Understanding these mechanisms is crucial for ensuring the security and integrity of your applications and our services.
Priority: High
Related Endpoints:
/auth/token/auth/refresh/auth/revoke1. API Keys
API keys are a simple authentication method that allows you to identify your application when making API requests. They are typically used for non-sensitive operations and are less secure than OAuth.
1.1 Obtaining an API Key
To obtain an API key, you must first register your application through our developer portal. Once registered, you can generate an API key from your application's settings.
1.2 Using an API Key
API keys are passed in the
X-API-Keyheader of your HTTP requests.