list_users

list_users

List users (requires admin privileges). Returns a list of users with filtering options. Available since Redmine 1.1

Input Schema

Name	Required	Description
`group_id`	No	Get only users who are members of the given group
`limit`	No	Number of items per page (max: 100)
`name`	No	Filter users on their login, firstname, lastname and mail. If pattern contains a space, matches firstname against first word and lastname against second word
`offset`	No	Number of items to skip
`status`	No	Filter by user status: 1: Active - User can login and use their account (default) 2: Registered - User has registered but not yet confirmed/activated 3: Locked - User was once active and is now locked

Input Schema (JSON Schema)

{
  "properties": {
    "group_id": {
      "description": "Get only users who are members of the given group",
      "type": "number"
    },
    "limit": {
      "default": 25,
      "description": "Number of items per page (max: 100)",
      "maximum": 100,
      "minimum": 1,
      "type": "number"
    },
    "name": {
      "description": "Filter users on their login, firstname, lastname and mail.\nIf pattern contains a space, matches firstname against first word\nand lastname against second word",
      "type": "string"
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip",
      "minimum": 0,
      "type": "number"
    },
    "status": {
      "description": "Filter by user status:\n1: Active - User can login and use their account (default)\n2: Registered - User has registered but not yet confirmed/activated\n3: Locked - User was once active and is now locked",
      "enum": [
        1,
        2,
        3
      ],
      "type": "number"
    }
  },
  "type": "object"
}

Input Schema

Input Schema (JSON Schema)

Other Tools