Get OAuth Settings
    • Dark
      Light
    • PDF

    Get OAuth Settings

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/settings.oauth

    List all the OAuth services. enabled in the workspace.

    Changelog

    VersionDescription
    0.64.0Renamed field appId to clientId and added flag custom to indicate whether the OAuth service is customized and fix id inconsistence (set all cases to _id)
    0.63.0Added
    Responses
    200

    OK

    Success Example
    {
      "services": [
        {
          "_id": "iJeY7x4wxnh2p3pLr",
          "name": "facebook",
          "clientId": "test",
          "buttonLabelText": "test",
          "buttonColor": "#13679A",
          "buttonLabelColor": "#FFFFFF",
          "custom": false
        },
        {
          "_id": "iJeY7x4wxnh2p3pLr",
          "name": "twitter",
          "clientId": "test",
          "buttonLabelText": "",
          "buttonColor": "",
          "buttonLabelColor": "",
          "custom": false
        },
        {
          "_id": "5RQ4SBL3NuZKsqxaF",
          "service": "test",
          "clientId": "test",
          "custom": true,
          "serverURL": "/test/test",
          "tokenPath": "/oauth/token",
          "identityPath": "/me",
          "authorizePath": "/oauth/authorize",
          "scope": "openid",
          "buttonLabelText": "test",
          "buttonLabelColor": "#FFFFFF",
          "loginStyle": "popup",
          "buttonColor": "#13679A",
          "tokenSentVia": "payload",
          "identityTokenSentVia": "default",
          "usernameField": "dfsgdfgdfgdfgsd",
          "mergeUsers": true
        }
      ],
      "success": true
    }
    Expand All
    object
    services
    Array of object
    object
    _id
    string
    name
    string
    clientId
    string
    buttonLabelText
    string
    buttonColor
    string
    buttonLabelColor
    string
    custom
    boolean
    service
    string
    serverURL
    string
    tokenPath
    string
    identityPath
    string
    authorizePath
    string
    scope
    string
    loginStyle
    string
    tokenSentVia
    string
    identityTokenSentVia
    string
    usernameField
    string
    mergeUsers
    boolean
    success
    boolean

    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.