Get List of OAuth Apps
    • Dark
      Light
    • PDF

    Get List of OAuth Apps

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/oauth-apps.list

    Permission required: manage-oauth-apps

    Changelog

    VersionDescription
    2.4.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authorization token of the user.

    Example9HqLlyZOugD_0YdwAJF8V47U3QHXSq
    X-User-Id
    stringRequired

    The user ID of the user.

    ExampleaobEdbYhXfu5hkeqG
    Responses
    200
    Success Example
    {
      "oauthApps": [
        {
          "_id": "zapier",
          "name": "Zapier",
          "active": true,
          "clientId": "zapier",
          "clientSecret": "RTK6TlndaCIolhQhZ7_KHIGOKj41RnlaOq_o-7JKwLr",
          "redirectUri": "https://zapier.com/dashboard/auth/oauth/return/RocketChatDevAPI/",
          "_createdAt": "2019-10-17T22:55:32.787Z",
          "_createdBy": {
            "_id": "system",
            "username": "system"
          },
          "_updatedAt": "2019-10-17T22:55:32.787Z"
        }
      ],
      "success": true
    }
    Expand All
    object
    oauthApps
    Array of object
    object
    _id
    string
    name
    string
    active
    boolean
    clientId
    string
    clientSecret
    string
    redirectUri
    string
    _createdAt
    string
    _createdBy
    object
    _id
    string
    username
    string
    _updatedAt
    string
    success
    boolean
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    What's Next
    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.