Add Custom OAuth
- Print
- DarkLight
- PDF
Add Custom OAuth
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/settings.addCustomOAuth
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
X-2fa-Code
stringRequired
The 2FA code from the authentication method. If the method is password, encrypt it as SHA256.
X-2fa-method
stringRequired
The desired method to get the 2FA code. It can be email, totp, or password.
Body parameters
object
name
string Required
The name of the custom OAuth method that you want to add.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The parameter \"name\" is required [error-name-param-not-provided]",
"errorType": "error-name-param-not-provided"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?