Add OAuth Service
- Print
- DarkLight
- PDF
Add OAuth Service
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Add an OAuth service for users to log in to your workspace.
Method | Requires Auth | Permission |
---|---|---|
| Yes |
|
Payload parameters
Argument | Example | Required | Description |
---|---|---|---|
|
| Required | The name of the OAuth service you want to add. |
Example call
{
"msg": "method",
"method": "addOAuthService",
"id": "2",
"params": [
"Okta"
]
}
Example response
Success
{
"msg": "updated",
"methods": [
"2"
]
}
Error
Any of the following errors can occur on the endpoint.
No Permission: Occurs when the authenticated user doesn't have the
add-oauth-service
permission.
{
"msg": "result",
"id": "2",
"error": {
"isClientSafe": true,
"error": "error-action-not-allowed",
"reason": "Adding OAuth Services is not allowed",
"details": {
"method": "addOAuthService",
"action": "Adding_OAuth_Services"
},
"message": "Adding OAuth Services is not allowed [error-action-not-allowed]",
"errorType": "Meteor.Error"
}
}
Changelog
Version | Description |
---|---|
0.51.0 | Added |
Was this article helpful?