# OnlyAuth Python Library
<div align="left">
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
<!-- Start SDK Installation [installation] -->
## SDK Installation
```bash
pip install onlyauth
```
<!-- End SDK Installation [installation] -->
## Sign up for OnlyAuth 2FA API
Sign up for the [OnlyAuth 2FA API](https://app.onlyauth.io) to get your API credentials.
<!-- No Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
import onlyauth
from onlyauth.models import operations
s = onlyauth.Onlyauth(
bearer_auth="<YOUR_API_SECRET>",
)
req = operations.CreateAccessTokenRequestBody(
app_id='<APPX-XXX>',
client_id='<CLNT-XXX>',
end_user_phone_number='<+14151002000>',
end_user_uuid='<12345>',
redirect_uri='<https://www.example.com>',
language='<en-US>',
region='<us-1>',
)
res = s.authentication.create_access_token(req)
if res.object is not None:
# handle response
pass
```
<!-- No End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
### [authentication](docs/sdks/authentication/README.md)
* [create_access_token](docs/sdks/authentication/README.md#create_access_token) - Creates a short-lived JWT token to integrate the widget
* [validate_success_token](docs/sdks/authentication/README.md#validate_success_token) - Validates a success token after user completes authentication
### [apps](docs/sdks/apps/README.md)
* [get_apps](docs/sdks/apps/README.md#get_apps) - Get all apps
* [new_app](docs/sdks/apps/README.md#new_app) - Create a new app
* [delete_app](docs/sdks/apps/README.md#delete_app) - Delete an app
* [get_app_by_id](docs/sdks/apps/README.md#get_app_by_id) - Get an app by uuid
* [update_app](docs/sdks/apps/README.md#update_app) - Update an app
<!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] -->
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
| -------------------- | -------------------- | -------------------- |
| errors.ErrorResponse | 400,401 | application/json |
| errors.SDKError | 4x-5xx | */* |
### Example
```python
import onlyauth
from onlyauth.models import errors, operations
s = onlyauth.Onlyauth(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateAccessTokenRequestBody(
app_id='<value>',
client_id='<value>',
end_user_phone_number='<value>',
end_user_uuid='<value>',
redirect_uri='<value>',
language='<value>',
region='<value>',
)
res = None
try:
res = s.authentication.create_access_token(req)
except errors.ErrorResponse as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res.object is not None:
# handle response
pass
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.onlyauth.io` | None |
#### Example
```python
import onlyauth
from onlyauth.models import operations
s = onlyauth.Onlyauth(
server_idx=0,
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateAccessTokenRequestBody(
app_id='<value>',
client_id='<value>',
end_user_phone_number='<value>',
end_user_uuid='<value>',
redirect_uri='<value>',
language='<value>',
region='<value>',
)
res = s.authentication.create_access_token(req)
if res.object is not None:
# handle response
pass
```
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
import onlyauth
from onlyauth.models import operations
s = onlyauth.Onlyauth(
server_url="https://api.onlyauth.io",
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateAccessTokenRequestBody(
app_id='<value>',
client_id='<value>',
end_user_phone_number='<value>',
end_user_uuid='<value>',
redirect_uri='<value>',
language='<value>',
region='<value>',
)
res = s.authentication.create_access_token(req)
if res.object is not None:
# handle response
pass
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
For example, you could specify a header for every request that this sdk makes as follows:
```python
import onlyauth
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = onlyauth.Onlyauth(client: http_client)
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `bearer_auth` | http | HTTP Bearer |
To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
```python
import onlyauth
from onlyauth.models import operations
s = onlyauth.Onlyauth(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
req = operations.CreateAccessTokenRequestBody(
app_id='<value>',
client_id='<value>',
end_user_phone_number='<value>',
end_user_uuid='<value>',
redirect_uri='<value>',
language='<value>',
region='<value>',
)
res = s.authentication.create_access_token(req)
if res.object is not None:
# handle response
pass
```
<!-- End Authentication [security] -->
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
<!-- No SDK Installation -->
<!-- No SDK Example Usage -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
Raw data
{
"_id": null,
"home_page": "https://www.onlyauth.io",
"name": "onlyauth",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "2fa,mfa,two factor auth,2fa api",
"author": "OnlyAuth",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/fe/db/10267cac0a137f5c7a887d507214fb74dd7f1c81a793d3bd47adb51c201d/onlyauth-0.0.3.tar.gz",
"platform": null,
"description": "# OnlyAuth Python Library\n\n<div align=\"left\">\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n```bash\npip install onlyauth\n```\n<!-- End SDK Installation [installation] -->\n\n\n## Sign up for OnlyAuth 2FA API\n\nSign up for the [OnlyAuth 2FA API](https://app.onlyauth.io) to get your API credentials.\n\n<!-- No Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\nimport onlyauth\nfrom onlyauth.models import operations\n\ns = onlyauth.Onlyauth(\n bearer_auth=\"<YOUR_API_SECRET>\",\n)\n\nreq = operations.CreateAccessTokenRequestBody(\n app_id='<APPX-XXX>',\n client_id='<CLNT-XXX>',\n end_user_phone_number='<+14151002000>',\n end_user_uuid='<12345>',\n redirect_uri='<https://www.example.com>',\n language='<en-US>',\n region='<us-1>',\n)\n\nres = s.authentication.create_access_token(req)\n\nif res.object is not None:\n # handle response\n pass\n```\n<!-- No End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n### [authentication](docs/sdks/authentication/README.md)\n\n* [create_access_token](docs/sdks/authentication/README.md#create_access_token) - Creates a short-lived JWT token to integrate the widget\n* [validate_success_token](docs/sdks/authentication/README.md#validate_success_token) - Validates a success token after user completes authentication\n\n### [apps](docs/sdks/apps/README.md)\n\n* [get_apps](docs/sdks/apps/README.md#get_apps) - Get all apps\n* [new_app](docs/sdks/apps/README.md#new_app) - Create a new app\n* [delete_app](docs/sdks/apps/README.md#delete_app) - Delete an app\n* [get_app_by_id](docs/sdks/apps/README.md#get_app_by_id) - Get an app by uuid\n* [update_app](docs/sdks/apps/README.md#update_app) - Update an app\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.\n\n| Error Object | Status Code | Content Type |\n| -------------------- | -------------------- | -------------------- |\n| errors.ErrorResponse | 400,401 | application/json |\n| errors.SDKError | 4x-5xx | */* |\n\n### Example\n\n```python\nimport onlyauth\nfrom onlyauth.models import errors, operations\n\ns = onlyauth.Onlyauth(\n bearer_auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nreq = operations.CreateAccessTokenRequestBody(\n app_id='<value>',\n client_id='<value>',\n end_user_phone_number='<value>',\n end_user_uuid='<value>',\n redirect_uri='<value>',\n language='<value>',\n region='<value>',\n)\n\nres = None\ntry:\n res = s.authentication.create_access_token(req)\nexcept errors.ErrorResponse as e:\n # handle exception\n raise(e)\nexcept errors.SDKError as e:\n # handle exception\n raise(e)\n\nif res.object is not None:\n # handle response\n pass\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Index\n\nYou can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://api.onlyauth.io` | None |\n\n#### Example\n\n```python\nimport onlyauth\nfrom onlyauth.models import operations\n\ns = onlyauth.Onlyauth(\n server_idx=0,\n bearer_auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nreq = operations.CreateAccessTokenRequestBody(\n app_id='<value>',\n client_id='<value>',\n end_user_phone_number='<value>',\n end_user_uuid='<value>',\n redirect_uri='<value>',\n language='<value>',\n region='<value>',\n)\n\nres = s.authentication.create_access_token(req)\n\nif res.object is not None:\n # handle response\n pass\n```\n\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nimport onlyauth\nfrom onlyauth.models import operations\n\ns = onlyauth.Onlyauth(\n server_url=\"https://api.onlyauth.io\",\n bearer_auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nreq = operations.CreateAccessTokenRequestBody(\n app_id='<value>',\n client_id='<value>',\n end_user_phone_number='<value>',\n end_user_uuid='<value>',\n redirect_uri='<value>',\n language='<value>',\n region='<value>',\n)\n\nres = s.authentication.create_access_token(req)\n\nif res.object is not None:\n # handle response\n pass\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nimport onlyauth\nimport requests\n\nhttp_client = requests.Session()\nhttp_client.headers.update({'x-custom-header': 'someValue'})\ns = onlyauth.Onlyauth(client: http_client)\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------------- | ------------- | ------------- |\n| `bearer_auth` | http | HTTP Bearer |\n\nTo authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:\n```python\nimport onlyauth\nfrom onlyauth.models import operations\n\ns = onlyauth.Onlyauth(\n bearer_auth=\"<YOUR_BEARER_TOKEN_HERE>\",\n)\n\nreq = operations.CreateAccessTokenRequestBody(\n app_id='<value>',\n client_id='<value>',\n end_user_phone_number='<value>',\n end_user_uuid='<value>',\n redirect_uri='<value>',\n language='<value>',\n region='<value>',\n)\n\nres = s.authentication.create_access_token(req)\n\nif res.object is not None:\n # handle response\n pass\n```\n<!-- End Authentication [security] -->\n\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!\n\n\n<!-- No SDK Installation -->\n<!-- No SDK Example Usage -->\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "OnlyAuth Python Library to quickly and easily add 2FA to your website/app",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://www.onlyauth.io",
"Source": "https://github.com/onlyauth-io/onlyauth-python"
},
"split_keywords": [
"2fa",
"mfa",
"two factor auth",
"2fa api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e8261f8cc3ecc81916b61d334e3109ca54952d43a6a0141f56c245a108308fd",
"md5": "48cbde4c3df76730f1c3286e13ace5dd",
"sha256": "0ca9cc1292dbf15b09ebe45bfbffca42d3138276cd7029c285bdc6188a8c7d32"
},
"downloads": -1,
"filename": "onlyauth-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48cbde4c3df76730f1c3286e13ace5dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27441,
"upload_time": "2024-02-28T11:24:20",
"upload_time_iso_8601": "2024-02-28T11:24:20.880953Z",
"url": "https://files.pythonhosted.org/packages/2e/82/61f8cc3ecc81916b61d334e3109ca54952d43a6a0141f56c245a108308fd/onlyauth-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fedb10267cac0a137f5c7a887d507214fb74dd7f1c81a793d3bd47adb51c201d",
"md5": "e939a59131fcb0aebdd5c0a063c50e0f",
"sha256": "70ce82a10b71376a35d8076f3de197b5405b10455ee80948c583d7e860e1856e"
},
"downloads": -1,
"filename": "onlyauth-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "e939a59131fcb0aebdd5c0a063c50e0f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19168,
"upload_time": "2024-02-28T11:24:22",
"upload_time_iso_8601": "2024-02-28T11:24:22.515461Z",
"url": "https://files.pythonhosted.org/packages/fe/db/10267cac0a137f5c7a887d507214fb74dd7f1c81a793d3bd47adb51c201d/onlyauth-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 11:24:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "onlyauth-io",
"github_project": "onlyauth-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "onlyauth"
}
JSON
