| Name | cflr JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | A Cloudflare Admin CLI. |
| upload_time | 2024-01-23 06:36:18 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.11 |
| license | |
| keywords |
cloudflare
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `cflr` a Cloudflare Admin CLI
A collection of commands for working with a Cloudflare account.
This package authenticates against the [Cloudflare API](https://developers.cloudflare.com/api/) using environment variables. For managing these securely consider the excellent [cf-vault](https://github.com/jacobbednarz/cf-vault) project.
## Quickstart
:warning: Python `>=3.11.x` required.
```sh
$ git clone
$ python -m venv .venv
$ source .venv/bin/activate # DO NOT SKIP THIS STEP!
# install dependencies (pyproject.toml)
# if developing run `python -m pip install -e ".[dev]"` for an editable install
$ python -m pip install .
# run cflr
$ cflr --help
# or
$ python -m cflr --help
# or
$ python cflr/cli.py --help
```
## Commands
### `$ sso`
- **Enterprise** only.
- API endpoint: `/accounts/:account_id/sso/v2/connectors` (undocumented as of 2024-01-13)
- Requires [Global API Key](https://developers.cloudflare.com/fundamentals/api/get-started/keys/) environment variables to be set.
`list`/`enable`/`disable` the SSO email domains configured.
#### Why is this useful
Cloudflare allow Enterprise plans to configure IdP's to [enforce SSO access to the dashboard](https://developers.cloudflare.com/cloudflare-one/applications/configure-apps/dash-sso-apps/) across email domain(s).
:warning: If the IdP were to suffer an outage, access to the Cloudflare dashboard would be impacted as the SSO flow would fail.
In this instance, **disabling** the associated SSO email domain(s) will allow users to fallback to logging in via username/password/2FA.
#### Usage
```sh
$ cflr sso --help
$ cflr sso list :account_id
$ cflr sso disable :account_id # an interactive pick list is returned
$ cflr sso enable :account_id # an interactive pick list is returned
```
Raw data
{
"_id": null,
"home_page": "",
"name": "cflr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "cloudflare,cli",
"author": "",
"author_email": "James Deane <dev@jwdeane.com>",
"download_url": "https://files.pythonhosted.org/packages/a8/f8/b2900f8165cb21e3f43b6a4770f4dd60a32003214f41534768c916957e65/cflr-0.0.1.tar.gz",
"platform": null,
"description": "# `cflr` a Cloudflare Admin CLI\n\nA collection of commands for working with a Cloudflare account.\n\nThis package authenticates against the [Cloudflare API](https://developers.cloudflare.com/api/) using environment variables. For managing these securely consider the excellent [cf-vault](https://github.com/jacobbednarz/cf-vault) project.\n\n## Quickstart\n\n:warning: Python `>=3.11.x` required.\n\n```sh\n$ git clone\n$ python -m venv .venv\n$ source .venv/bin/activate # DO NOT SKIP THIS STEP!\n# install dependencies (pyproject.toml)\n# if developing run `python -m pip install -e \".[dev]\"` for an editable install\n$ python -m pip install .\n# run cflr\n$ cflr --help\n# or\n$ python -m cflr --help\n# or\n$ python cflr/cli.py --help\n```\n\n## Commands\n\n### `$ sso`\n\n- **Enterprise** only.\n- API endpoint: `/accounts/:account_id/sso/v2/connectors` (undocumented as of 2024-01-13)\n - Requires [Global API Key](https://developers.cloudflare.com/fundamentals/api/get-started/keys/) environment variables to be set.\n\n`list`/`enable`/`disable` the SSO email domains configured.\n\n#### Why is this useful\n\nCloudflare allow Enterprise plans to configure IdP's to [enforce SSO access to the dashboard](https://developers.cloudflare.com/cloudflare-one/applications/configure-apps/dash-sso-apps/) across email domain(s).\n\n:warning: If the IdP were to suffer an outage, access to the Cloudflare dashboard would be impacted as the SSO flow would fail.\n\nIn this instance, **disabling** the associated SSO email domain(s) will allow users to fallback to logging in via username/password/2FA.\n\n#### Usage\n\n```sh\n$ cflr sso --help\n$ cflr sso list :account_id\n$ cflr sso disable :account_id # an interactive pick list is returned\n$ cflr sso enable :account_id # an interactive pick list is returned\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A Cloudflare Admin CLI.",
"version": "0.0.1",
"project_urls": {
"homepage": "https://github.com/25thhour/cflr.dev",
"issues": "https://github.com/25thhour/cflr.dev/issues"
},
"split_keywords": [
"cloudflare",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4dd1c3b17cfce65503fef6047b5d092993a6b4269c12e459b52782373061f1a5",
"md5": "c43b1c703924b0ee480f3defb85fda49",
"sha256": "2a548214bf8eeb6e77f2f964f6f5005e86e9aff398c020ff06d56b626ad64436"
},
"downloads": -1,
"filename": "cflr-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c43b1c703924b0ee480f3defb85fda49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 5358,
"upload_time": "2024-01-23T06:36:14",
"upload_time_iso_8601": "2024-01-23T06:36:14.879462Z",
"url": "https://files.pythonhosted.org/packages/4d/d1/c3b17cfce65503fef6047b5d092993a6b4269c12e459b52782373061f1a5/cflr-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8f8b2900f8165cb21e3f43b6a4770f4dd60a32003214f41534768c916957e65",
"md5": "b1c872ef1c0135da277fc858cda00f2f",
"sha256": "081565eb944c87622fe038eb7335277c6c34c9eab9a61dc97e5be34108315323"
},
"downloads": -1,
"filename": "cflr-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b1c872ef1c0135da277fc858cda00f2f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 4541,
"upload_time": "2024-01-23T06:36:18",
"upload_time_iso_8601": "2024-01-23T06:36:18.015959Z",
"url": "https://files.pythonhosted.org/packages/a8/f8/b2900f8165cb21e3f43b6a4770f4dd60a32003214f41534768c916957e65/cflr-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-23 06:36:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "25thhour",
"github_project": "cflr.dev",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cflr"
}
