معرفی شرکت ها
authress-sdk-2.0.21
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Authress SDK for authorization as a service and interact with the Authress API.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | authress-sdk-2.0.21 |
| نام | authress-sdk |
| نسخه کتابخانه | 2.0.21 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Rhosys Developers |
| ایمیل نویسنده | developers@authress.io |
| آدرس صفحه اصلی | https://github.com/Authress/authress-sdk.py.git |
| آدرس اینترنتی | https://pypi.org/project/authress-sdk/ |
| مجوز | Apache-2.0 |
# authress-sdk
Authress SDK for Python.
[](https://badge.fury.io/py/authress-sdk) [](https://travis-ci.com/authress/authress-sdk.py)
This is the Authress SDK used to integrate with the authorization as a service provider Authress at https://authress.io.
## Usage
```sh
pip install authress-sdk
```
(you may need to run `pip` with root permission: `sudo pip install authress-sdk`)
Then import the package:
```python
import authress_sdk
```
## Getting Started
### Authorize using a user token
```python
from authress_sdk import AuthressClient
# create an instance of the API class during service initialization
# Authress custom domain or if there isn't one yet, use the authress account specific url
host = "https://login.your.domain.com" # or "https://ACCOUNT_ID.api.authress.io"
authress_client = AuthressClient(host)
# on api route
from flask import request
from authress_sdk import ApiException
@app.route('/resources/<resourceId>')
def get_resource(resourceId):
# Get the user token and pass it to authress
authorization_token = request.headers.get('authorization')
authress_client.set_token(authorization_token)
# Check Authress to authorize the user
try
authress_client.users.authorize_user(None, f'resources/{resourceId}', 'READ')
except ApiException as api_exception:
# Will throw except if the user is not authorized to read the resource
if api_exception.status is 403:
return 403
raise api_exception
# On success, continue with the route code to load resource and return it
return 'Resource', 200
```
### Authorize with a service client
```python
from authress_sdk import AuthressClient
# create an instance of the API class during service initialization
# Authress custom domain or if there isn't one yet, use the authress account specific url
host = "https://login.your.domain.com" # or "https://ACCOUNT_ID.api.authress.io"
# Create a service client in the Authress management portal and past the access token here
access_token = 'eyJrZXlJ....'
authress_client = AuthressClient(host, access_token)
# on api route
from flask import request
from authress_sdk import ApiException
@app.route('/resources/<resourceId>')
def get_resource(resourceId):
# Get the user
user_id = get_user_id(request)
# Check Authress to authorize the user
try
authress_client.users.authorize_user(user_id, f'resources/{resourceId}', 'READ')
except ApiException as api_exception:
# Will throw except if the user is not authorized to read the resource
if api_exception.status is 403:
return 403
raise api_exception
# On success, continue with the route code to load resource and return it
return 'Resource', 200
```
## Using the Authress service client as an API key
You can use the Authress service client access token as an api key for your application. This is as simple as pulling in the SDK and referencing the token provider.
### Application SDK example
```python
from authress_sdk import AuthressClient
access_key = "eyARB5k-..." # For your API clients, these can be created via the API at https://authress.io/app/#/api
authress_host = None # Optionally you can call the Authress API if there are authress resources to be fetched
authress_client = AuthressClient(authress_host, access_key)
# Generates a JWT to be used as a Bearer token for your API
jwt_token = authress_client.get_client_token()
```
In the case of a CLI or an SDK, the recommendation is to receive the access key from the user, perform these steps and then use the resulting `jwt_token` with your API. You can handle the JWTs as you would validate any JWT, in most cases it might be easier to make a request to Authress on the service side for token validation. An example is above:
```python
authress_client.set_token(jwt_token)
authress_client.users.authorize_user(...)
```
### Generation of service client
Since part of this process involves creating the service client and access token as part of your api. First create a service client which has `Authress:Owner` to resource `Authress:ServiceClients/*`. Then execute the following on user request to create a new api key.
```python
from authress_sdk import AuthressClient
from authress_sdk.models import *
# Your service's service client access token
access_token = 'eyJrZXlJ....'
# Authress custom domain or if there isn't one yet, use the authress account specific url
host = "https://login.your.domain.com" # or "https://ACCOUNT_ID.api.authress.io"
authress_client = AuthressClient(host, access_token)
# User to create access token for
user_id = 'USER_A1'
# Create the service client
new_client = authress_client.clients.create_client(Client(name=f'ServiceClient for User {user_id}'))
# Give the service client access to the users data
authress_client.records.create_record(AccessRecord(
name=f'API Key {new_client.client_id}',
users=[AccessRecordUser(f'Authress:ServiceClients/{new_client.client_id}')],
# Add the list of permissions this api key should have, for example here we've added all access to all the users resources as defined in Authress
statements=[AccessRecordStatement(['Authress:Owner'], [AccessRecordResource(f'/users/{user_id}')])]))
# Request a new access key for that client
data = service_client_api.request_access_key(new_client.client_id)
# Return the access key to the user for usage
return data.access_key
```
### Token Verifier
To verify incoming tokens from Authress call the `verify_token` method on the `AuthressClient`
```python
from authress_sdk import AuthressClient
# User's access token from request
authorization_token = request.headers.get("authorization")
# Authress custom domain or if there isn't one yet, use the authress account specific url
host = "https://login.your.domain.com" # or "https://ACCOUNT_ID.api.authress.io"
# Instantiate the client
authress_client = AuthressClient(host)
# Verify the token, on successful verification the response is the decoded user identity JWT. On failure this raises an exception
user_identity = authress_client.verify_token(authorization_token)
```
نیازمندی
| مقدار | نام |
|---|---|
| >=1.15 | urllib3 |
| >=1.10 | six |
| - | certifi |
| - | python-dateutil |
| >=2.0.0 | PyJWT |
| >=2.9.2 | cryptography |
نحوه نصب
نصب پکیج whl authress-sdk-2.0.21:
pip install authress-sdk-2.0.21.whl
نصب پکیج tar.gz authress-sdk-2.0.21:
pip install authress-sdk-2.0.21.tar.gz