JSON-RPC:Security group

JSON Methods

• rpc: set_issuer, info, add_timer, del_timer
• stats: get
• log: send, list, subscribe, unsubscribe
• user: list, get, set_nick, set_username, set_realname, set_vhost, set_mode, set_snomask, set_oper
• whowas: get
• server: list, get, rehash, connect, disconnect
• channel: list, get, set_mode, set_topic, kick
• server_ban: list, get, add, del
• server_ban_exception: list, get, add, del
• spamfilter: list, get, add, del
• name_ban: list, get, add, del
• message: send_privmsg, send_notice, send_numeric, send_standard_reply
• connthrottle: status, set, reset,
• security_group: list, get

JSON Basics

• JSON-RPC Technical documentation

The security_group.* JSON RPC calls allow you to list security groups and see details about them.

API Calls

security_group.list

Get the list of available security groups.

Request arguments

None

Response

A list of security group objects (name/priority/public/builtin).

Example

{
  "jsonrpc": "2.0",
  "method": "security_group.list",
  "id": 1,
  "result": {
    "list": [
      {
        "name": "unknown-users",
        "priority": 0,
        "public": true,
        "builtin": true
      },
      {
        "name": "tls-or-local",
        "priority": 1
      },
      {
        "name": "untrusted-user",
        "priority": 1
      },
      {
        "name": "trusted-user",
        "priority": 1
      },
      {
        "name": "webirc-users",
        "priority": 50,
        "public": true,
        "builtin": true
      },
      {
        "name": "websocket-users",
        "priority": 51,
        "public": true,
        "builtin": true
      },
      {
        "name": "known-users",
        "priority": 100,
        "public": true,
        "builtin": true
      },
      {
        "name": "tls-users",
        "priority": 300,
        "public": true,
        "builtin": true
      }
    ]
  }
}

security_group.get

Get details of a particular security groups.

Request arguments

Mandatory:

• name: The name of the security-group

Response

A security group object.

Example

{
  "jsonrpc": "2.0",
  "method": "security_group.get",
  "id": 1,
  "result": {
    "name": "known-users",
    "priority": 100,
    "identified": true,
    "reputation_score": 25,
    "public": true,
    "builtin": true
  }
}