Tanker identity library
Project description
Tanker identity generation in Python for the Tanker SDK.
Installation
With pip:
$ pip install tankersdk-identity
API
tankersdk_identity.create_identity(app_id, app_secret, user_id)
Create a new Tanker identity. This identity is secret and must only be given to a user who has been authenticated by your application. This identity is used by the Tanker client SDK to open a Tanker session
- app_id
The app ID. You can access it from the Tanker dashboard.
- app_secret
The app secret. A secret that you have saved right after the creation of your app.
- user_id
The ID of a user in your application.
tankersdk_identity.create_provisional_identity(app_id, email)
Create a Tanker provisional identity. It allows you to share a resource with a user who does not have an account in your application yet.
- app_id
The app ID. You can access it from the Tanker dashboard.
The email of the potential recipient of the resource.
tankersdk_identity.get_public_identity(identity)
Return the public identity from an identity. This public identity can be used by the Tanker client SDK to share encrypted resource.
- identity
A secret identity.
tankersdk_identity.upgrade_user_token(app_id, user_id, user_token)
Return a Tanker identity from Tanker v1 user Token. Tanker v1 used a user token, when migrating to Tanker v2 you should use this function to migrate you used tokens to identities. This identity is secret and must only be given to a user who has been authenticated by your application. This identity is used by the Tanker client SDK to open a Tanker session
- app_id
The app ID. You can access it from the Tanker dashboard.
- user_id
The ID of a user in your application.
- user_token
The Tanker v1 user token.
Going further
Read more about identities in the Tanker guide.
Check the examples folder for usage examples.
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.