Upload facts via the PDP
To help reduce the data sync latency and wait for data sync before we check permissions on this data. We added a way to send the data updates directly to the PDP, and it will spread it to all the other PDPs (in multi PDP setup)
The way it works is the PDP forwards the facts to the connected OPAL Server and the OPAL Server will then distribute the facts to all the PDPs in the environment. You don't have to worry about the unsupported APIs as the SDK takes care of it for you. This enables you to use the same favorite SDK to interact with the PDP as you previously interacted with Permit Cloud and upload the facts directly to the PDP. It will also ensure all other PDPs running in your environment receive those facts. The way it works is the PDP forwards the facts to the connected OPAL Server and the OPAL Server will then distribute the facts to all the PDPs in the environment.
Notice that this API is in Early Access Program stage and might be subject to changes.
Notice that this feature is available from PDP version 0.5.1 and above.
How to configure the SDK to upload facts via the PDP
This will allow you to use the same SDK to upload facts via PDP.
- Python
- Node.js
- Go
from permit import Permit
# This line initializes the SDK and connects your python app
# to the Permit.io PDP container you've set up.
permit = Permit(
# your secret API KEY
token="<your-api-key>",
# In production, you might need to change this URL to fit your deployment
# This is the address where you can find the PDP container.
pdp="http://localhost:7766",
# configure the SDK to upload facts via the PDP
proxy_facts_via_pdp=True,
# Add here any more configurations that you usually use
)
import { Permit } from "permit";
const permit = new Permit({
// your secret API KEY
token: "<your-api-key>",
// In production, you might need to change this URL to fit your deployment
// This is the address where you can find the PDP container.
pdp: "http://localhost:7766",
// configure the SDK to upload facts via the PDP
proxyFactsViaPdp: true,
// Add here any more configurations that you usually use
});
package main
import "github.com/permitio/permit-golang/pkg/permit"
import "github.com/permitio/permit-golang/pkg/config"
func main() {
PermitConfig := config.NewConfigBuilder("<YOUR_API_TOKEN>").
WithPdpUrl("http://localhost:7766").
WithProxyFactsViaPdp().
Build()
Permit := permit.New(PermitConfig)
}
After configuring you can use the normal SDK functions to upload facts and the SDK will take care of the rest.
Wait for the fact to be ready for permission check
Using the following guide you will be able to wait for the PDP to be ready to enforce permission on the newly added facts. Timeout with value 0 will respond immediately without waiting. Timeout with a positive value will wait for the facts to be synced for the specified duration. Timeout with a negative value will wait forever for the facts to be synced.
Waiting for the facts to be synced is available only when proxy_facts_via_pdp is enabled
- Python
- Node.js
- Go
from permit import Permit
# This line initializes the SDK and connects your python app
# to the Permit.io PDP container you've set up.
permit = Permit(
# your secret API KEY
token="<your-api-key>",
# In production, you might need to change this URL to fit your deployment
# This is the address where you can find the PDP container.
pdp="http://localhost:7766",
# configure the SDK to upload facts via the PDP
proxy_facts_via_pdp=True,
# you can set the timeout to wait for the facts to be synced,
# in the initialization of the client - will apply for all the supported SDK calls
# as an argument to the sync_function call - will apply only for the calls inside the context manager
facts_sync_timeout=10,
# Add here any more configurations that you usually use
)
async with permit.wait_for_sync(timeout=15) as p:
user: UserRead = await p.api.users.sync(
{
"key": "auth0|elon",
"email": "elonmusk@tesla.com",
"first_name": "Elon",
"last_name": "Musk",
"attributes": {
"age": 50,
"favorite_color": "red",
},
}
)
import { Permit } from "permit";
const permit = new Permit({
// your secret API KEY
token: "<your-api-key>",
// In production, you might need to change this URL to fit your deployment
// This is the address where you can find the PDP container.
pdp: "http://localhost:7766",
// configure the SDK to upload facts via the PDP
proxyFactsViaPdp: true,
// configure the default time to wait for the facts to be synced
factsSyncTimeout: 10,
// Add here any more configurations that you usually use
});
await permit.api.users.sync({
key: "auth0|elon",
email: "elonmusk@tesla.com",
first_name: "Elon",
last_name: "Musk",
attributes: {
age: 50,
favorite_color: "red",
},
});
// or you can use the waitForSync function to customize the timeout for a specific call
await permit.api.users.waitForSync(10).create({ key: "auth0|elon" });
package main
import "github.com/permitio/permit-golang/pkg/permit"
import "github.com/permitio/permit-golang/pkg/config"
func main() {
PermitConfig := config.NewConfigBuilder("<YOUR_API_TOKEN>").
WithPdpUrl("http://localhost:7766").
WithProxyFactsViaPdp().
WithFactsSyncTimeout().
Build()
Permit := permit.New(PermitConfig)
newUser := models.NewUserCreate("new_user")
user, _ := Permit.Api.Users.SyncUser(ctx, *newUser)
// or you can use the WaitForSync function to customize the timeout for a specific call
user, _ := Permit.Api.Users.WaitForSync(10).CreateUser(ctx, *newUser)
}
Currently supported APIs for this feature are: