user
entity represents users. This entity is empty because it’s only responsible for referencing users.
organization
entity has its own relations (admin
and member
) which related with user entity. This entity also has 2 actions, respectively:
Required | Argument | Type | Default | Description |
---|---|---|---|---|
[x] | tenant_id | string | - | identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant t1 for this field. |
[x] | schema | string | - | Permify Schema as string |
/v1/tenants/{tenant_id}/schemas/write
Required | Argument | Type | Default | Description |
---|---|---|---|---|
[x] | tenant_id | string | - | identifier of the tenant, if you are not using multi-tenancy (have only one tenant in your system) use pre-inserted tenant t1 for this field. |
[x] | tuples | array | - | Can contain multiple relation tuple object |
[x] | entity | object | - | Type and id of the entity. Example: “organization:1” |
[x] | relation | string | - | Custom relation name. Eg. admin, manager, viewer etc. |
[x] | subject | string | - | User or user set who wants to take the action. |
[ ] | schema_version | string | 8 | Version of the schema |
/v1/tenants/{tenant_id}/data/write
/v1/tenants/{tenant_id}/permissions/check
Required | Argument | Type | Default | Description |
---|---|---|---|---|
[x] | tenant_id | string | - | identifier of the tenant, if you are not using multi-tenancy (have only one tenant in your system) use pre-inserted tenant t1 for this field. |
[x] | entity | object | - | name and id of the entity. Example: organization:1. |
[x] | action | string | - | the action the user wants to perform on the resource |
[x] | subject | object | - | the user or user set who wants to take the action |
[ ] | schema_version | string | - | get results according to given schema version |
[ ] | depth | integer | 8 | - |