Python library to help manage your Passage application and users
Project description
passage-python
This Python SDK allows for verification of server-side authentication for applications using Passage
Install this package using pip.
pip install passage-identity
Instantiating the Passage Class
Passage has three arguments that can be used for initialization: app_id
, api_key
, and auth_strategy
.
app_id
is the Passage App ID that specifies which app should be authorized. It has no default value and must to be set upon initialization.api_key
is an API key for the Passage app, which can be generated in the 'App Settings' section of the Passage Console. It is an optional parameter and not required for authenticating requests. It is required to get or update user information.auth_strategy
defines where the Passage SDK should look for the authentication token. It is set by default toPassage.COOKIE_AUTH
, but can be changed toPassage.HEADER_AUTH
.
Authenticating a Request
To authenticate an HTTP request in a Flask application, you can use the Passage library in a middleware function. You need to provide Passage with your app ID in order to verify the JWTs.
from passageidentity import Passage
import os
PASSAGE_APP_ID_ = os.environ.get("PASSAGE_APP_ID")
def exampleFlaskMiddleware(request):
psg = Passage(PASSAGE_APP_ID)
user = psg.authenticateRequest(request)
Retrieve App Info
To retrieve information about an app , you should use the getApp
method.
from passageidentity import Passage
import os
PASSAGE_APP_ID_ = os.environ.get("PASSAGE_APP_ID")
psg = Passage(PASSAGE_APP_ID)
app_info = psg.getApp()
The information available in the Passage App object is as
Field | Type |
---|---|
name | string |
id | string |
auth_origin | string |
redirect_url | string |
login_url | string |
rsa_public_key | boolean |
allowed_identifier | string |
require_identifier_verification | boolean |
session_timeout_length | int |
user_metadata_schema | list |
layouts | list |
Retrieve User Info
To retrieve information about a user, you should use the getPassageUser
method. You will need to use a Passage API key, which can be created in the Passage Console under your Application Settings. This API key grants your web server access to the Passage management APIs to get and update information about users.
This API key must be protected and stored in an appropriate secure storage location. It should never be hard-coded in the repository.
from passageidentity import Passage
import os
PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID")
PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY")
psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
def exampleFlaskMiddleware(request):
g.user = psg.authenticateRequest(request)
@auth.route('/home')
def authenticatedEndpoint():
user = psg.getPassageUser(g.user)
print(user.email)
The information available in the Passage User object is as
Field | Type |
---|---|
id | string |
string | |
phone | string |
status | string |
email_verified | boolean |
phone_verified | boolean |
created_at | Datetime |
last_login_at | Datetime |
webauthn | boolean |
webauthn_devices | array |
recent_events | array of PassageEvents |
Activate/Deactivate User
You can also activate or deactivate a user using the Passage SDK. These actions require an API Key and deactivating a user will prevent them from logging into your application with Passage.
from passageidentity import Passage
import os
PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID")
PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY")
psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
# Get Passage User ID from database
# ...
#activate or deactivate this user
psg.deactivateUser(user_id)
Update User Attributes
You can also update a user's attributes using the Passage SDK. This will require a Passage API Key.
from passageidentity import Passage
import os
PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID")
PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY")
psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
# Get Passage User ID from database
# ...
# update a user (note that user_metadata is optional)
psg.updateUser(user_id, {
"email": "newEmail@domain.com",
"phone": "+15005550006",
"user_metadata": {
"example1": "example metadata"
}
})
Create User
You can also create users using their email address or phone number. Note that their phone number must be in E164 format (example shown below).
from passageidentity import Passage
import os
PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID")
PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY")
psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
# Get Passage User ID from database
# ...
# create a user via their email (note that user_metadata is optional)
psg.createUser({
"email": "exampleEmail@domain.com",
"user_metadata": {
"example1": "example metadata"
}
})
# create a user via their phone number
psg.createUser({"phone": "+15005550007"})
Delete User
from passageidentity import Passage
import os
PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID")
PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY")
psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
# Get Passage User ID from database
# ...
# delete a user via their userID
deleted_user = psg.deleteUser(user_id)
if deleted_user:
print("User has been deleted")
Create an Embeddable Magic Link
To create a magic link, you should use the createMagicLink
method. The method takes in MagicLinkAttributes
, which is in this structure:
Field | Type |
---|---|
user_id | string |
string | |
phone | string |
channel | ChannelType |
send | boolean |
magic_link_path | string |
redirect_url | string |
The information it returns is in a PassageMagicLink object with this structure:
Field | Type |
---|---|
id | string |
secret | string |
activated | boolean |
user_id | string |
app_id | string |
identifier | string |
type | Datetime |
webauthn | boolean |
webauthn_devices | array |
recent_events | array of PassageEvents |
from passageidentity import Passage
import os
PASSAGE_APP_ID = os.environ.get("PASSAGE_APP_ID")
PASSAGE_API_KEY = os.environ.get("PASSAGE_API_KEY")
psg = Passage(PASSAGE_APP_ID, PASSAGE_API_KEY)
# create a magic link
magicLink = psg.createMagicLink(magicLinkAttributes={"email": "<example@email.com>", "channel": "email"})
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for passage_identity-2.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db7ff6344c3e64fcd93e5183029a91a68313a2e8f2d80d0add6101b03f4271d6 |
|
MD5 | dc87d4e9a4adbdc65447516e79d5e19b |
|
BLAKE2b-256 | a91359fa6e38b1e4cab7a83608aff2a10295e8291f2758c0f78078a025241078 |