Add OAuth Service
    • Dark
      Light
    • PDF

    Add OAuth Service

    • Dark
      Light
    • PDF

    Article summary

    Add an OAuth service for users to log in to your workspace.

    Method

    Requires Auth

    Permission

    addOAuthService

    Yes

    add-oauth-service

    Payload parameters

    Argument

    Example

    Required

    Description

    name

    okta

    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?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence