You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*DataApi* | [**relationships_write**](docs/DataApi.md#relationships_write) | **POST** /v1/tenants/{tenant_id}/relationships/write | create new relationships
100
-
*PermissionApi* | [**permissions_check**](docs/PermissionApi.md#permissions_check) | **POST** /v1/tenants/{tenant_id}/permissions/check | This method returns a decision about whether user can perform an permission on a certain resource.
101
-
*PermissionApi* | [**permissions_expand**](docs/PermissionApi.md#permissions_expand) | **POST** /v1/tenants/{tenant_id}/permissions/expand | expand relationships according to schema
102
-
*PermissionApi* | [**permissions_lookup_entity**](docs/PermissionApi.md#permissions_lookup_entity) | **POST** /v1/tenants/{tenant_id}/permissions/lookup-entity | Retrieve an entity by its identifier.
103
-
*PermissionApi* | [**permissions_lookup_entity_stream**](docs/PermissionApi.md#permissions_lookup_entity_stream) | **POST** /v1/tenants/{tenant_id}/permissions/lookup-entity-stream | Stream entities by their identifiers.
104
-
*PermissionApi* | [**permissions_lookup_subject**](docs/PermissionApi.md#permissions_lookup_subject) | **POST** /v1/tenants/{tenant_id}/permissions/lookup-subject | Retrieve a subject by its identifier.
105
-
*PermissionApi* | [**permissions_subject_permission**](docs/PermissionApi.md#permissions_subject_permission) | **POST** /v1/tenants/{tenant_id}/permissions/subject-permission | Retrieve permissions related to a specific subject.
106
-
*SchemaApi* | [**schemas_list**](docs/SchemaApi.md#schemas_list) | **POST** /v1/tenants/{tenant_id}/schemas/list | list all authorization models
107
-
*SchemaApi* | [**schemas_read**](docs/SchemaApi.md#schemas_read) | **POST** /v1/tenants/{tenant_id}/schemas/read | read your authorization model
108
-
*SchemaApi* | [**schemas_write**](docs/SchemaApi.md#schemas_write) | **POST** /v1/tenants/{tenant_id}/schemas/write | write your authorization model
109
-
*TenancyApi* | [**tenants_create**](docs/TenancyApi.md#tenants_create) | **POST** /v1/tenants/create | create new tenant
The \"Delete Bundle\" API is designed for removing specific data bundles within a multi-tenant application environment. This API facilitates the deletion of a bundle, identified by its unique name, from a designated tenant's environment.
18
-
19
17
### Example
20
18
21
19
@@ -86,8 +84,6 @@ No authorization required
86
84
87
85
read bundle
88
86
89
-
The \"Read Bundle\" API is a crucial tool for retrieving details of specific data bundles in a multi-tenant application setup. It is designed to access information about a bundle, uniquely identified by its name, within the specified tenant's environment.
90
-
91
87
### Example
92
88
93
89
@@ -158,8 +154,6 @@ No authorization required
158
154
159
155
write bundle
160
156
161
-
The \"Write Bundle\" API is designed for handling data in a multi-tenant application environment. Its primary function is to write and delete data according to predefined structures. This API allows users to define or update data bundles, each distinguished by a unique name.
The \"Run Bundle\" API provides a straightforward way to execute predefined bundles within your application's tenant environment. By sending a POST request to this endpoint, you can activate specific functionalities or processes encapsulated in a bundle.
print("The response of DataApi->data_relationships_read:\n")
267
259
pprint(api_response)
@@ -304,9 +296,7 @@ No authorization required
304
296
# **data_write**
305
297
> DataWriteResponse data_write(tenant_id, body)
306
298
307
-
create data
308
-
309
-
In Permify, attributes and relations between your entities, objects and users represents your authorization data. These data stored as tuples in a preferred database.
299
+
write data
310
300
311
301
### Example
312
302
@@ -333,7 +323,7 @@ with permify.ApiClient(configuration) as api_client:
333
323
body = permify.DataWriteRequest() # DataWriteRequest |
Copy file name to clipboardExpand all lines: docs/PermissionApi.md
+18-30Lines changed: 18 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,18 @@ All URIs are relative to *http://localhost*
4
4
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
-
[**permissions_check**](PermissionApi.md#permissions_check) | **POST** /v1/tenants/{tenant_id}/permissions/check | This method returns a decision about whether user can perform an permission on a certain resource.
8
-
[**permissions_expand**](PermissionApi.md#permissions_expand) | **POST** /v1/tenants/{tenant_id}/permissions/expand | expand relationships according to schema
9
-
[**permissions_lookup_entity**](PermissionApi.md#permissions_lookup_entity) | **POST** /v1/tenants/{tenant_id}/permissions/lookup-entity | Retrieve an entity by its identifier.
10
-
[**permissions_lookup_entity_stream**](PermissionApi.md#permissions_lookup_entity_stream) | **POST** /v1/tenants/{tenant_id}/permissions/lookup-entity-stream | Stream entities by their identifiers.
11
-
[**permissions_lookup_subject**](PermissionApi.md#permissions_lookup_subject) | **POST** /v1/tenants/{tenant_id}/permissions/lookup-subject | Retrieve a subject by its identifier.
12
-
[**permissions_subject_permission**](PermissionApi.md#permissions_subject_permission) | **POST** /v1/tenants/{tenant_id}/permissions/subject-permission | Retrieve permissions related to a specific subject.
7
+
[**permissions_check**](PermissionApi.md#permissions_check) | **POST** /v1/tenants/{tenant_id}/permissions/check | check api
8
+
[**permissions_expand**](PermissionApi.md#permissions_expand) | **POST** /v1/tenants/{tenant_id}/permissions/expand | expand api
This method returns a decision about whether user can perform an permission on a certain resource.
19
-
20
-
In Permify, you can perform two different types access checks, resource based authorization checks, in form of Can user U perform action Y in resource Z? subject based authorization checks, in form of Which resources can user U edit? In this section we'll look at the resource based check request of Permify. You can find subject based access checks in Entity (Data) Filtering section.
18
+
check api
21
19
22
20
### Example
23
21
@@ -44,7 +42,7 @@ with permify.ApiClient(configuration) as api_client:
44
42
body = permify.PermissionsCheckRequest() # PermissionsCheckRequest |
45
43
46
44
try:
47
-
#This method returns a decision about whether user can perform an permission on a certain resource.
Retrieve all subjects (users and user sets) that have a relationship or attribute with given entity and permission. Expand API response is represented by a user set tree, whose leaf nodes are user IDs or user sets pointing to other ⟨object#relation⟩ pairs. <Tip>WHEN TO USE ? Expand is designed for reasoning the complete set of users that have access to their objects, which allows our users to build efficient search indices for access-controlled content. It is not designed to use as a check access. Expand request has a high latency which can cause a performance issues when its used as access check.</Tip>
88
+
expand api
93
89
94
90
### Example
95
91
@@ -116,7 +112,7 @@ with permify.ApiClient(configuration) as api_client:
116
112
body = permify.PermissionsExpandRequest() # PermissionsExpandRequest |
Lookup Entity endpoint lets you ask questions in form of “Which resources can user:X do action Y?”. As a response of this you’ll get a entity results in a format of string array.
158
+
lookup entity
165
159
166
160
### Example
167
161
@@ -188,7 +182,7 @@ with permify.ApiClient(configuration) as api_client:
188
182
body = permify.PermissionsLookupEntityRequest() # PermissionsLookupEntityRequest |
Lookup Entity endpoint lets you ask questions in form of “Which resources can user:X do action Y?”. As a response of this you’ll get a entity results in a format of as a streaming response.
228
+
lookup entity stream
237
229
238
230
### Example
239
231
@@ -260,7 +252,7 @@ with permify.ApiClient(configuration) as api_client:
260
252
body = permify.PermissionsLookupEntityRequest() # PermissionsLookupEntityRequest |
Lookup Subject endpoint lets you ask questions in form of “Which subjects can do action Y on entity:X?”. As a response of this you’ll get a subject results in a format of string array.
298
+
lookup-subject
309
299
310
300
### Example
311
301
@@ -332,7 +322,7 @@ with permify.ApiClient(configuration) as api_client:
332
322
body = permify.PermissionsLookupSubjectRequest() # PermissionsLookupSubjectRequest |
Retrieve permissions related to a specific subject.
379
-
380
-
The Subject Permission List endpoint allows you to inquire in the form of “Which permissions user:x can perform on entity:y?”. In response, you'll receive a list of permissions specific to the user for the given entity, returned in the format of a map. In this endpoint, you'll receive a map of permissions and their statuses directly. The structure is map[string]CheckResult, such as \"sample-permission\" -> \"ALLOWED\". This represents the permissions and their associated states in a key-value pair format.
368
+
subject permission
381
369
382
370
### Example
383
371
@@ -404,7 +392,7 @@ with permify.ApiClient(configuration) as api_client:
404
392
body = permify.PermissionsSubjectPermissionRequest() # PermissionsSubjectPermissionRequest |
405
393
406
394
try:
407
-
#Retrieve permissions related to a specific subject.
0 commit comments