Sidebar

api:usergroup:exists

Table of Contents

exists()

Available since version: 1.8.3
This function allows you to check whether user group with given user group name or user group ID exists.

Parameters

ParameterTypeOptionalDescriptionDetails
nodeidsarrayyes List of node IDs where to search for given user group ID or name
usrgrpidstringyes User group ID
namestringyes User group name

Returns

ParameterDescription
resultOperation successful. Result will contain boolean variable.
errorIn case of any errors

Example

{
"jsonrpc":"2.0",
"method":"usergroup.exists",
"params":{
    "nodeids": ["1"],
    "name": "Admin Group"
},
"auth":"3a57200802b24cda67c4e4010b50c065",
"id":2
}

User group exists:

{
"jsonrpc":"2.0",
"result": true,
"id":2
}