docs: add apikey authorization #148
Merged
Conversation
This file contains 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
|
Deploy preview for cloudtower-api-doc ready! ✅ Preview Built with commit 05d275d. |
netweng
reviewed
Feb 21, 2025
|
|
||
| 在默认环境中，使用用户名，密码登录后即可换回 token，可以正常使用 token 进行鉴权，但是在开启了双因子认证后，无法单纯通过用户名，密码换回 token，会需要一个额外的第二因子验证，而在 API 的业务场景中，执行是无交互的，无法进行第二因子验证。 | ||
|
|
||
| 在此类环境下，如果需要使用 CloudTower API，可以选择使用 API Key 进行鉴权。 |
There was a problem hiding this comment.
在此类环境下，如果需要使用 CloudTower API，可以选择使用 API Key 进行鉴权。
只在此类环境下吗？是不是应该无论什么情况下，都建议用户优先使用 API key 做鉴权 ？
| import GetToken from '../../code_blocks/GetToken.md' | ||
| import GetTokenResponse from '../../code_blocks/GetTokenResponse.md' | ||
| import GetToken from '../../../code_blocks/GetToken.md' | ||
| import GetTokenResponse from '../../../code_blocks/GetTokenResponse.md' | ||
|
|
There was a problem hiding this comment.
这个文档可能需要加多一个提示，使用 token 鉴权的话，如果对接 cloudtower 环境开启了双因子，则无法换取到 token ？
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.
增加 apikey 相关的文档说明