wbx-admin-utils


Namewbx-admin-utils JSON
Version 1.3.2 PyPI version JSON
download
home_page
SummaryA collection of utilities for Webex Control Hub admins and compliance officers
upload_time2023-12-21 13:24:14
maintainer
docs_urlNone
author
requires_python>=3.10
licenseMIT License Copyright (c) 2023 Stephane Cohen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords control hub webex groups
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ## Usage:
( You might need to replace "python3" for "python3" )
```
python3 -m wbx_admin_utils [options] command subcommand [parameters]
python3 -m wbx_admin_utils help commands # shows the full list of available commmands

```

## Commands:
```
help
   commands : display list of available commands
group
   list : list all groups in admin org
   list-users <group_id> : list user ids (max 500) in given group id
   add-user <email|csvFile> <group_id> : add user in given group id
   remove-user <email|csvFile> <group_id> : remove user from given group id
user
   details <email|user_id> : print user details in json
   tokens <email|csvFile> : list user(s) access token
   reset <email|csvFile> : reset user(s) access token
   activate <Yes|No> <email|csvFile> : activate (Yes) or deactivate (No) user(s)
   delete <email|csvFile> : delete user(s)
   get-vm <email> : dump user voicemail settings in json format
   add-vm <email|csvFile> <base user email> : set user(s) voicemail options based on another user's voicemail settings
co
   list-messages <email, 'options'> : list messages sent by a user
   list-space-members <id> : list menbers in space
```

## Options:
* -t \<token\> Adds access token as a parameter. Will be read from AUTH_BEARER Env Variable by defaut. Yyou can get your personal access token from [webex developper](https://developer.webex.com/docs/getting-your-personal-access-token)
* -d \<debugLevel> from 0 to 3 (most verbose). Default is 2 (info level)

## co (compliance officer) commands 
* list-messages option format is in json format as per the 'event' API command 
* all results are displayed in .CSV format 

## Examples:
```
# List user groups in CH Org
python3 -m wbx_admin_utils group list

# List users in group id
python3 -m wbx_admin_utils group list-users ``<groupid>``

# Add or remove users in specified group id
python3 -m wbx_admin_utils group add-user user1@customer.com ``<groupid>``
python3 -m wbx_admin_utils group remove-user /tmp/users.csv ``<groupid>``

# Reset (force log-out) user access tokens
python3 -m wbx_admin_utils user reset /tmp/users.csv

# Activate or deactivate users
python3 -m wbx_admin_utils user activate Yes user1@customer.com
python3 -m wbx_admin_utils user activate No /tmp/users.csv

# list messages sent by user (default from = 30 days ago, default to = today)
python3 -m wbx_admin_utils co list-messages user1@customer.com > report.csv 
python3 -m wbx_admin_utils co list-messages user1@customer.com '{"from":"2022-10-20T00:00:00.000Z", "to":"2023-10-20T00:00:00.000Z" }'

# list members of a space  
python3 -m wbx_admin_utils co list-space-members <spaceid>

```


## CSV input file format:
```
email, comments
user1@customer.com, some optinal info about user1
user2@customer.com, some optinal info about user1
```
The first column is currenlty processed and must be titled 'email' other columns are optional and ignored.

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "wbx-admin-utils",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "Control Hub,Webex,groups",
    "author": "",
    "author_email": "Stephane Cohen <stecohen@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/42/f3/6e23313f57ec45c2c31790db0387ebf05f6eae86eb91d6b5bf7a17155742/wbx_admin_utils-1.3.2.tar.gz",
    "platform": null,
    "description": "## Usage:\n( You might need to replace \"python3\" for \"python3\" )\n```\npython3 -m wbx_admin_utils [options] command subcommand [parameters]\npython3 -m wbx_admin_utils help commands # shows the full list of available commmands\n\n```\n\n## Commands:\n```\nhelp\n   commands : display list of available commands\ngroup\n   list : list all groups in admin org\n   list-users <group_id> : list user ids (max 500) in given group id\n   add-user <email|csvFile> <group_id> : add user in given group id\n   remove-user <email|csvFile> <group_id> : remove user from given group id\nuser\n   details <email|user_id> : print user details in json\n   tokens <email|csvFile> : list user(s) access token\n   reset <email|csvFile> : reset user(s) access token\n   activate <Yes|No> <email|csvFile> : activate (Yes) or deactivate (No) user(s)\n   delete <email|csvFile> : delete user(s)\n   get-vm <email> : dump user voicemail settings in json format\n   add-vm <email|csvFile> <base user email> : set user(s) voicemail options based on another user's voicemail settings\nco\n   list-messages <email, 'options'> : list messages sent by a user\n   list-space-members <id> : list menbers in space\n```\n\n## Options:\n* -t \\<token\\> Adds access token as a parameter. Will be read from AUTH_BEARER Env Variable by defaut. Yyou can get your personal access token from [webex developper](https://developer.webex.com/docs/getting-your-personal-access-token)\n* -d \\<debugLevel> from 0 to 3 (most verbose). Default is 2 (info level)\n\n## co (compliance officer) commands \n* list-messages option format is in json format as per the 'event' API command \n* all results are displayed in .CSV format \n\n## Examples:\n```\n# List user groups in CH Org\npython3 -m wbx_admin_utils group list\n\n# List users in group id\npython3 -m wbx_admin_utils group list-users ``<groupid>``\n\n# Add or remove users in specified group id\npython3 -m wbx_admin_utils group add-user user1@customer.com ``<groupid>``\npython3 -m wbx_admin_utils group remove-user /tmp/users.csv ``<groupid>``\n\n# Reset (force log-out) user access tokens\npython3 -m wbx_admin_utils user reset /tmp/users.csv\n\n# Activate or deactivate users\npython3 -m wbx_admin_utils user activate Yes user1@customer.com\npython3 -m wbx_admin_utils user activate No /tmp/users.csv\n\n# list messages sent by user (default from = 30 days ago, default to = today)\npython3 -m wbx_admin_utils co list-messages user1@customer.com > report.csv \npython3 -m wbx_admin_utils co list-messages user1@customer.com '{\"from\":\"2022-10-20T00:00:00.000Z\", \"to\":\"2023-10-20T00:00:00.000Z\" }'\n\n# list members of a space  \npython3 -m wbx_admin_utils co list-space-members <spaceid>\n\n```\n\n\n## CSV input file format:\n```\nemail, comments\nuser1@customer.com, some optinal info about user1\nuser2@customer.com, some optinal info about user1\n```\nThe first column is currenlty processed and must be titled 'email' other columns are optional and ignored.",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Stephane Cohen  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "A collection of utilities for Webex Control Hub admins and compliance officers",
    "version": "1.3.2",
    "project_urls": null,
    "split_keywords": [
        "control hub",
        "webex",
        "groups"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc0dcb0e0dacce02e7d890586af1ae0071d9fcf21754b90d20b287045e89f63b",
                "md5": "b20505c779ca26417d4e19ed08e144a0",
                "sha256": "561f9da005c3ff3ec145b680e43f8bbc538193874de4e234d2983a9ce1c1e4d0"
            },
            "downloads": -1,
            "filename": "wbx_admin_utils-1.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b20505c779ca26417d4e19ed08e144a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10150,
            "upload_time": "2023-12-21T13:24:12",
            "upload_time_iso_8601": "2023-12-21T13:24:12.564254Z",
            "url": "https://files.pythonhosted.org/packages/bc/0d/cb0e0dacce02e7d890586af1ae0071d9fcf21754b90d20b287045e89f63b/wbx_admin_utils-1.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42f36e23313f57ec45c2c31790db0387ebf05f6eae86eb91d6b5bf7a17155742",
                "md5": "0d67010bf7d025df4c41981ffd1e5a8b",
                "sha256": "2247eb1a1c81264c3adcc031f6fda2b57eb8eebdc9f21f8012b7cdfaec04a31a"
            },
            "downloads": -1,
            "filename": "wbx_admin_utils-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "0d67010bf7d025df4c41981ffd1e5a8b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 8636,
            "upload_time": "2023-12-21T13:24:14",
            "upload_time_iso_8601": "2023-12-21T13:24:14.358247Z",
            "url": "https://files.pythonhosted.org/packages/42/f3/6e23313f57ec45c2c31790db0387ebf05f6eae86eb91d6b5bf7a17155742/wbx_admin_utils-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-21 13:24:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "wbx-admin-utils"
}
Elapsed time: 0.16187s