usergroupsUsersList
List all users in a User Group
Details
- Method:
GET - Path:
/usergroups.users.list - Operation ID:
usergroups_users_list
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `usergroups:read`",
"required": true,
"location": "query",
"type": "string"
},
"include_disabled": {
"description": "Allow results that involve disabled User Groups.",
"required": false,
"location": "query",
"type": "string"
},
"usergroup": {
"description": "The encoded ID of the User Group to update.",
"required": true,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "Schema for successful response from usergroups.users.list method",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
},
"users": {
"items": {
"pattern": "^[UW][A-Z0-9]{2,}$",
"title": "User ID",
"type": "string"
},
"type": "array"
}
},
"required": [
"ok",
"users"
],
"title": "usergroups.users.list schema",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('usergroupsUsersList', {
# Add required parameters here
})