Sidebar

manual:appendix:api:usergroup:iswritable

usergroup.iswritable

Description

boolean usergroup.iswritable(array userGroupIds)

This method checks if the given user groups are available for writing.

Parameters

(array) IDs of the user groups to check.

Return values

(boolean) Returns true if the given user groups are available for writing.

Examples

Check multiple user groups

Check if the two user groups are writable.

Request:

{
    "jsonrpc": "2.0",
    "method": "usergroup.iswritable",
    "params": [
        "21",
        "22"
    ],
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

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

See also

Source

CUserGroup::isWritable() in frontends/php/api/classes/CUserGroup.php.