List All Permissions
    • Dark
      Light
    • PDF

    List All Permissions

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/permissions.listAll

    Returns the list of permissions from the workspace.

    Changelog

    VersionDescription
    0.73.0Added
    Header parameters
    X-User-Id
    stringRequired

    The authenticated user ID.

    ExamplerbAXPnMktTFbNpwtJ
    X-Auth-Token
    stringRequired

    The authenticated user token.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    Query parameters
    updatedSince
    string

    Date as ISO string. If you include this parameter, the update and remove fields in the response will contain only those permissions updated and removed since this date and time.

    Example2017-11-25T15:08:17.248Z
    Responses
    200

    OK

    Success Example
    {
      "update": [
        {
          "_id": "access-permissions",
          "_updatedAt": "2018-11-28T11:55:49.106Z",
          "roles": [
            "admin"
          ]
        },
        {
          "_id": "add-oauth-service",
          "_updatedAt": "2018-11-28T12:59:51.974Z",
          "roles": [
            "admin",
            "user"
          ]
        }
      ],
      "remove": [],
      "success": true
    }
    Expand All
    object
    update
    Array of object
    object
    _id
    string
    _updatedAt
    string
    roles
    Array of string
    string
    remove
    Array of object
    object
    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?

    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.