diff --git a/docs/api/rbac/overview.mdx b/docs/api/rbac/overview.mdx index 886e04552..c84a2a99c 100644 --- a/docs/api/rbac/overview.mdx +++ b/docs/api/rbac/overview.mdx @@ -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 diff --git a/docs/authentication/auth0/permit-integration.mdx b/docs/authentication/auth0/permit-integration.mdx index 4ac4b3190..8396ec68f 100644 --- a/docs/authentication/auth0/permit-integration.mdx +++ b/docs/authentication/auth0/permit-integration.mdx @@ -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: diff --git a/docs/authentication/cognito/permit-integration.mdx b/docs/authentication/cognito/permit-integration.mdx index 27b530503..cad9ba567 100644 --- a/docs/authentication/cognito/permit-integration.mdx +++ b/docs/authentication/cognito/permit-integration.mdx @@ -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: diff --git a/docs/home.mdx b/docs/home.mdx index 1b1972000..e0350584a 100644 --- a/docs/home.mdx +++ b/docs/home.mdx @@ -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", diff --git a/docs/how-to/sync-users.mdx b/docs/how-to/sync-users.mdx index b945eb28a..f2a3a4b74 100644 --- a/docs/how-to/sync-users.mdx +++ b/docs/how-to/sync-users.mdx @@ -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 diff --git a/docs/how-to/use-audit-logs/errors/no_permission.mdx b/docs/how-to/use-audit-logs/errors/no_permission.mdx index 2542ae43c..488cf1b11 100644 --- a/docs/how-to/use-audit-logs/errors/no_permission.mdx +++ b/docs/how-to/use-audit-logs/errors/no_permission.mdx @@ -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) diff --git a/docs/how-to/use-audit-logs/errors/no_role_in_tenant.mdx b/docs/how-to/use-audit-logs/errors/no_role_in_tenant.mdx index 36f5124ab..e66309ee0 100644 --- a/docs/how-to/use-audit-logs/errors/no_role_in_tenant.mdx +++ b/docs/how-to/use-audit-logs/errors/no_role_in_tenant.mdx @@ -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) diff --git a/docs/how-to/use-audit-logs/errors/no_such_action.mdx b/docs/how-to/use-audit-logs/errors/no_such_action.mdx index 442a99096..fb7382744 100644 --- a/docs/how-to/use-audit-logs/errors/no_such_action.mdx +++ b/docs/how-to/use-audit-logs/errors/no_such_action.mdx @@ -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) diff --git a/docs/how-to/use-audit-logs/errors/no_such_resource.mdx b/docs/how-to/use-audit-logs/errors/no_such_resource.mdx index 27bf923ba..502f56067 100644 --- a/docs/how-to/use-audit-logs/errors/no_such_resource.mdx +++ b/docs/how-to/use-audit-logs/errors/no_such_resource.mdx @@ -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) diff --git a/docs/how-to/use-audit-logs/errors/no_such_tenant.mdx b/docs/how-to/use-audit-logs/errors/no_such_tenant.mdx index e4eca21d6..c3a04cf67 100644 --- a/docs/how-to/use-audit-logs/errors/no_such_tenant.mdx +++ b/docs/how-to/use-audit-logs/errors/no_such_tenant.mdx @@ -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). diff --git a/docs/how-to/use-audit-logs/errors/no_user_roles.mdx b/docs/how-to/use-audit-logs/errors/no_user_roles.mdx index e007911b8..11179389c 100644 --- a/docs/how-to/use-audit-logs/errors/no_user_roles.mdx +++ b/docs/how-to/use-audit-logs/errors/no_user_roles.mdx @@ -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. diff --git a/docs/how-to/use-audit-logs/errors/user_not_synced.mdx b/docs/how-to/use-audit-logs/errors/user_not_synced.mdx index 7191813b7..0b0d0384d 100644 --- a/docs/how-to/use-audit-logs/errors/user_not_synced.mdx +++ b/docs/how-to/use-audit-logs/errors/user_not_synced.mdx @@ -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. diff --git a/docs/sdk/_category_.json b/docs/sdk/_category_.json index 1f1312987..3ff66352c 100644 --- a/docs/sdk/_category_.json +++ b/docs/sdk/_category_.json @@ -4,7 +4,7 @@ "collapsible": true, "collapsed": true, "link": { - "type": "generated-index", - "description": "Working with the Permit SDK" + "type": "doc", + "id": "sdks-overview" } } \ No newline at end of file diff --git a/docs/sdk/sdks-overview.mdx b/docs/sdk/sdks-overview.mdx new file mode 100644 index 000000000..f376e1b8a --- /dev/null +++ b/docs/sdk/sdks-overview.mdx @@ -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 | ๐Ÿ”ด | ๐Ÿ”ด | ๐Ÿ”ด | ๐Ÿ”ด | โœ… | ๐Ÿ”ด | ๐ŸŸค | \ No newline at end of file