W

Refine•17mo ago

Action values

What are the values that Refine uses for

action

action

in the context of access control? So far I've come across:

list

list

,

show

show

,

edit

edit

,

delete

delete

&

create

create

. Is there a type or interface that defines them and that can be used to reference them programatically?

kapa.ai

K

kapa.ai•8/14/24, 9:51 PM

Hi @Nitai. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base.

kapa.ai

K

kapa.ai•8/14/24, 9:52 PM

----------------------
In Refine, the

action

action

values used in the context of access control and other functionalities include

list

list

,

show

show

,

edit

edit

,

delete

delete

,

create

create

, and . These actions are used to define what operations can be performed on resources.

The

action

action

values can be referenced programmatically using the and hooks, which provide the

action

action

property. Here are the relevant details:

Hook

The hook provides the

action

action

property among others:

Source (https://refine.dev/docs/routing/hooks/use-resource-params/#properties)

Hook

The hook also provides the

action

action

property:

Source (https://refine.dev/docs/routing/hooks/use-resource/#return-value)

kapa.ai

K

kapa.ai•8/14/24, 9:52 PM

Access Control Provider

The uses these actions to determine if a user can perform a certain action on a resource:

Source (https://refine.dev/docs/guides-concepts/authorization/#access-control-provider)

Command Palette

The package also uses these actions to create default actions:

Source (https://refine.dev/docs/packages/command-palette/#actions)

These hooks and providers ensure that the actions are consistently referenced and used throughout your Refine application.
----------------------
Note: you can ask me a follow up question by @ mentioning me again

----------------------

| Property | Type | Description |
| --- | --- | --- |
| id | `**BaseKey** (<https://refine.dev/docs/core/interface-references/#basekey>)` |  |
| resource | `string` |  |
| action | `"create" | "edit" | "list" | "show" | "clone"` |  |

| Property | Type | Description |
| --- | --- | --- |
| id | `**BaseKey** (<https://refine.dev/docs/core/interface-references/#basekey>)` |  |
| resource | `string` |  |
| action | `"create" | "edit" | "list" | "show" | "clone"` |  |

| Description | Type |
| --- | --- |
| resources | **`IResourceItem[]`** (<https://refine.dev/docs/routing/hooks/use-resource/#interfaces>) |
| resource | **`IResourceItem` | `undefined`** (<https://refine.dev/docs/routing/hooks/use-resource/#interfaces>) |
| resourceName | `string` | `undefined` |
| id | **`BaseKey`** (<https://refine.dev/docs/core/interface-references/#basekey>) |
| action | `undefined` | `"list"` | `"create"` | `"edit"` | `"show"` | `"clone"` |
| select | `(resourceName: string, force?: boolean) => { resource: IResourceItem` | `undefined, identifier: string` | `undefined}` |
| identifier | `string` | `undefined` |

| Description | Type |
| --- | --- |
| resources | **`IResourceItem[]`** (<https://refine.dev/docs/routing/hooks/use-resource/#interfaces>) |
| resource | **`IResourceItem` | `undefined`** (<https://refine.dev/docs/routing/hooks/use-resource/#interfaces>) |
| resourceName | `string` | `undefined` |
| id | **`BaseKey`** (<https://refine.dev/docs/core/interface-references/#basekey>) |
| action | `undefined` | `"list"` | `"create"` | `"edit"` | `"show"` | `"clone"` |
| select | `(resourceName: string, force?: boolean) => { resource: IResourceItem` | `undefined, identifier: string` | `undefined}` |
| identifier | `string` | `undefined` |

import { AccessControlProvider } from "@refinedev/core";  
  
export const accessControlProvider: AccessControlProvider = {  
  can: async ({ resource, action, params }) => {  
    console.log(resource); // products, orders, etc.  
    console.log(action); // list, edit, delete, etc.  
    console.log(params); // { id: 1 }, { id: 2 }, etc.  
  
    if (meetSomeCondition) {  
      return { can: true };  
    }  
  
    return {  
      can: false,  
      reason: "Unauthorized",  
    };  
  },  
};

import { AccessControlProvider } from "@refinedev/core";  
  
export const accessControlProvider: AccessControlProvider = {  
  can: async ({ resource, action, params }) => {  
    console.log(resource); // products, orders, etc.  
    console.log(action); // list, edit, delete, etc.  
    console.log(params); // { id: 1 }, { id: 2 }, etc.  
  
    if (meetSomeCondition) {  
      return { can: true };  
    }  
  
    return {  
      can: false,  
      reason: "Unauthorized",  
    };  
  },  
};