Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/rbac/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Overview

Using the API directly is the most flexible way to integrate with the platform.
This is a RESTful API that uses JSON for serialization and bearer tokens for authentication.
You can use any HTTP client in any programming language to interact with the API. or you can use one of the [official SDKs](/category/-sdks).
You can use any HTTP client in any programming language to interact with the API. or you can use one of the [official SDKs]( /sdk/sdks-overview).
You can also use CURL or PostMan to interact with it.

#### Sending API Requests
Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/auth0/permit-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ If you don't use Auth0's roles, you can skip this step and create your roles acc

:::

Setting up roles and resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/roles), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_role), or [with one of our SDKs](/category/-sdks).
Setting up roles and resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/roles), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_role), or [with one of our SDKs]( /sdk/sdks-overview).

### 1.2. Create the right resources in Permit

Create a corresponding resource in Permit for each of your application's resources. For instance, if you have a user management section in your app, you will need a `user` resource with `create`, `delete`, and `get` actions. If you have a task management section, you will need a `task` resource with `create`, `delete`, `get`, and `check` actions.

Setting up resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/resources), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_resource), or [with one of our SDKs](/category/-sdks).
Setting up resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/resources), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_resource), or [with one of our SDKs]( /sdk/sdks-overview).

### 1.3. Set up the right permissions in Permit.io:

Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/cognito/permit-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ For example, many simple RBAC applications will have three roles: `admin`, `edit

:::

Setting up roles and resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/roles), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_role), or [with one of our SDKs](/category/-sdks).
Setting up roles and resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/roles), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_role), or [with one of our SDKs]( /sdk/sdks-overview).
You can also follow this [Permit RBAC guide](https://www.permit.io/blog/planning-app-rbac)

### 1.2. Create the right resources in Permit

Create a corresponding resource in Permit for each of your application's resources. For instance, if your app has a user management section, you will need a `user` resource with `create`, `delete`, and `get` actions. If you have a task management section, you need a `task` resource with `create`, `delete`, `get`, and `check` actions.

Setting up resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/resources), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_resource), or [with one of our SDKs](/category/-sdks).
Setting up resources can be done through the [Permit dashboard](https://app.permit.io/policy-editor/resources), by using the [Permit API](https://api.permit.io/v2/redoc#tag/Roles/operation/create_resource), or [with one of our SDKs]( /sdk/sdks-overview).

### 1.3. Set up the right permissions in Permit.io:

Expand Down
2 changes: 1 addition & 1 deletion docs/home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Here you'll find comprehensive guides and resources to help you get started with
description: "Best practices and how to's",
},
{ type: 'link',
href: "category/-sdks",
href: "sdk/sdks-overview",
label: "SDKs",
icon: '🪛',
description: "Explore the supported SDKs and frameworks",
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/sync-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Usually, your existing users, as well as new ones, will originate in your authen

We [integrate with any authentication solution](/authentication/your-authentication) and provide the `syncUser` function for all of our SDKs.

A detailed explanation of how to use the `syncUser` function with each of our SDKs [is available here](/category/-sdks). The `syncUser` function will consist of:
A detailed explanation of how to use the `syncUser` function with each of our SDKs [is available here]( /sdk/sdks-overview). The `syncUser` function will consist of:

#### Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/no_permission.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Assign this permission to user roles using our SDKs. Links for reference:

- [Python SDK](https://docs.permit.io/sdk/python/role/assign-role)
- [Node SDK](https://docs.permit.io/sdk/nodejs/role/assign-role)
- [Browse other SDK's](/category/-sdks)
- [Browse other SDK's](/sdk/sdks-overview)
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/no_role_in_tenant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Roles can be delegated to users via the SDK. For guidance, check out the followi

- [Python SDK](https://docs.permit.io/sdk/python/role/assign-role)
- [Node SDK](https://docs.permit.io/sdk/nodejs/role/assign-role)
- [Browse other SDK's](/category/-sdks)
- [Browse other SDK's](/sdk/sdks-overview)
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/no_such_action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ To modify the resource, utilize the following SDKs:

- [Python SDK](https://docs.permit.io/sdk/python/resource/update-resource)
- [Node SDK](https://docs.permit.io/sdk/nodejs/resource/update-resource)
- [Browse other SDK's](/category/-sdks)
- [Browse other SDK's](/sdk/sdks-overview)
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/no_such_resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ You can create resource with our [Resource management API](https://api.permit.io
### Create resource with the SDK

Establish the resource with our [Python SDK](https://docs.permit.io/sdk/python/resource/create-resource),
[Node SDK](https://docs.permit.io/sdk/nodejs/resource/create-resource) and [other SDK's](/category/-sdks)
[Node SDK](https://docs.permit.io/sdk/nodejs/resource/create-resource) and [other SDK's](/sdk/sdks-overview)
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/no_such_tenant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ documentation on [creating a user](https://api.permit.io/v2/redoc#tag/Users/oper
With the help of our [Python SDK](https://docs.permit.io/sdk/python/tenant/create-tenant),
[Node SDK](https://docs.permit.io/sdk/nodejs/tenant/create-tenant), or other available SDKs, you can establish a new tenant. Post creation,
these SDKs offer functionalities to add users and allocate roles within the designated tenant. For further guidance, explore our
comprehensive [SDK documentation](/category/-sdks).
comprehensive [SDK documentation](/sdk/sdks-overview).
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/no_user_roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Roles can be conveniently assigned to users via our [API documentation](https://
### Assign roles to user via the SDK

Assign roles using our SDKs. Explore the [Python SDK](https://docs.permit.io/sdk/python/role/assign-role),
[Node SDK](https://docs.permit.io/sdk/nodejs/role/assign-role), or [other available SDKs](/category/-sdks) for more information.
[Node SDK](https://docs.permit.io/sdk/nodejs/role/assign-role), or [other available SDKs](/sdk/sdks-overview) for more information.
2 changes: 1 addition & 1 deletion docs/how-to/use-audit-logs/errors/user_not_synced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Use our [API](https://api.permit.io/v2/redoc#tag/Users/operation/create_user) to
### Sync the user to permit with the SDK

Leverage the SDK to create and synchronize the user to Permit. Explore [Python SDK](/sdk/python/usage-example#create-or-update-a-user-sync-user),
[Node SDK](/sdk/nodejs/user/sync-user), and [additional SDKs](/category/-sdks) for details.
[Node SDK](/sdk/nodejs/user/sync-user), and [additional SDKs](/sdk/sdks-overview) for details.
4 changes: 2 additions & 2 deletions docs/sdk/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"collapsible": true,
"collapsed": true,
"link": {
"type": "generated-index",
"description": "Working with the Permit SDK"
"type": "doc",
"id": "sdks-overview"
}
}
50 changes: 50 additions & 0 deletions docs/sdk/sdks-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: SDKs
description: ""
---


# SDK Feature Parity

This page lists the feature parity of the different SDKs that we provide to use Permit.io programmatically.

✅ - Full

🔴 - Missing

🟡 - Partial

🟤 - Not compatible

| Feature ⤵ | NodeJS | Go | .NET | Java | Python | Ruby | Terraform |
| --- | --- | --- | --- | --- | --- | --- | --- |
| Check | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | 🟤 |
| Check All Tenants | ✅ | ✅ | 🔴 | ✅ | 🔴 | 🔴 | 🟤 |
| Get User Permission | ✅ | ✅ | 🔴 | ✅ | 🔴 | 🔴 | 🟤 |
| Get User Tenant | 🔴 | 🔴 | 🔴 | ✅ | 🔴 | 🔴 | 🟤 |
| Check URL | 🔴 | 🔴 | 🔴 | ✅ | 🔴 | 🔴 | 🟤 |
| Sync User | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | 🟤 |
| Users | ✅ | ✅ | ✅ | ✅ | ✅ | 🟡 | ✅ |
| Resources | ✅ | ✅ | ✅ | ✅ | ✅ | 🟡 | ✅ |
| Tenants | ✅ | ✅ | ✅ | ✅ | ✅ | 🟡 | ✅ |
| Projects | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🔴 |
| Environments | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🔴 |
| Roles | ✅ | ✅ | ✅ | ✅ | ✅ | 🔴 | ✅ |
| Role Assignments | ✅ | ✅ | ✅ | ✅ | ✅ | 🔴 | 🔴 |
| Condition Sets | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | ✅ |
| Condition Set Rules | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | ✅ |
| Relationship Tuples | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🔴 |
| Resource Relations | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | ✅ |
| Role Derivations | 🔴 | ✅ | 🔴 | ✅ | 🔴 | 🔴 | ✅ |
| Resource Instances | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🔴 |
| Resource Roles | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🔴 |
| Resource Actions | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | ✅ |
| Resource Action Groups | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🔴 |
| Resource Attributes | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | ✅ |
| Bulk Check | ✅ | ✅ | 🔴 | 🔴 | ✅ | 🔴 | 🟤 |
| Elements Login | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | 🟤 |
| Bulk Users | 🔴 | 🔴 | 🔴 | 🔴 | ✅ | 🔴 | 🟤 |
| Bulk Relationship Tuples | ✅ | ✅ | 🔴 | 🔴 | ✅ | 🔴 | 🟤 |
| Bulk Role Assignments | ✅ | ✅ | 🔴 | ✅ | ✅ | 🔴 | 🟤 |
| Bulk Tenants | 🔴 | 🔴 | 🔴 | 🔴 | ✅ | 🔴 | 🟤 |
| Bulk Resource Instances | 🔴 | 🔴 | 🔴 | 🔴 | ✅ | 🔴 | 🟤 |