List Group Roles
    • Dark
      Light
    • PDF

    List Group Roles

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/groups.roles

    List all the roles of users in the group.

    Changelog

    VersionDescription
    0.65.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Responses
    200

    OK

    Example 1
    {
      "roles": [
        {
          "rid": "BaE62jfDLXK3Xo6BA",
          "u": {
            "_id": "BkNkw3iKgNyhMbPyW",
            "username": "ronnie.dio",
            "name": "Ronnie James Dio"
          },
          "roles": [
            "moderator"
          ],
          "_id": "ehPuGyZBedznJsQHp"
        }
      ],
      "success": true
    }
    Expand All
    object
    roles
    Array of object
    object
    rid
    string
    u
    object
    _id
    string
    username
    string
    name
    string
    roles
    Array of string
    string
    _id
    string
    success
    boolean

    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.