***
title: "PermissionDefinition"
generated: true
---------------
## PermissionDefinition
Defines a new Permission with which to control access to GraphQL resolvers & REST controllers.
Used in conjunction with the [Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator (see example below).
**Note:** To define CRUD permissions, use the [CrudPermissionDefinition](/current/core/reference/typescript-api/auth/permission-definition#crudpermissiondefinition).
*Example*
```ts
export const sync = new PermissionDefinition({
name: 'SyncInventory',
description: 'Allows syncing stock levels via Admin API'
});
```
```ts
const config: VendureConfig = {
authOptions: {
customPermissions: [sync],
},
}
```
```ts
@Resolver()
export class ExternalSyncResolver {
@Allow(sync.Permission)
@Mutation()
syncStockLevels() {
// ...
}
}
```
```ts title="Signature"
class PermissionDefinition {
constructor(config: PermissionDefinitionConfig)
Permission: Permission
}
```
### Permission
\Permission`} />
Returns the permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
## CrudPermissionDefinition
Defines a set of CRUD Permissions for the given name, i.e. a `name` of 'Wishlist' will create
4 Permissions: 'CreateWishlist', 'ReadWishlist', 'UpdateWishlist' & 'DeleteWishlist'.
*Example*
```ts
export const wishlist = new CrudPermissionDefinition('Wishlist');
```
```ts
const config: VendureConfig = {
authOptions: {
customPermissions: [wishlist],
},
}
```
```ts
@Resolver()
export class WishlistResolver {
@Allow(wishlist.Create)
@Mutation()
createWishlist() {
// ...
}
}
```
```ts title="Signature"
class CrudPermissionDefinition extends PermissionDefinition {
constructor(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string)
Create: Permission
Read: Permission
Update: Permission
Delete: Permission
}
```
* Extends: [`PermissionDefinition`](/current/core/reference/typescript-api/auth/permission-definition#permissiondefinition)
### Create
\Permission`} />
Returns the 'Create' CRUD permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
### Read
\Permission`} />
Returns the 'Read' CRUD permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
### Update
\Permission`} />
Returns the 'Update' CRUD permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
### Delete
\Permission`} />
Returns the 'Delete' CRUD permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
## RwPermissionDefinition
Defines a set of Read-Write Permissions for the given name, i.e. a `name` of 'DashboardSavedViews' will create
2 Permissions: 'ReadDashboardSavedViews' and 'WriteDashboardSavedViews'.
*Example*
```ts
export const dashboardSavedViews = new RwPermissionDefinition('DashboardSavedViews');
```
```ts
const config: VendureConfig = {
authOptions: {
customPermissions: [dashboardSavedViews],
},
}
```
```ts
@Resolver()
export class DashboardResolver {
@Allow(dashboardSavedViews.Read)
@Query()
getDashboardSavedViews() {
// ...
}
@Allow(dashboardSavedViews.Write)
@Mutation()
saveDashboardView() {
// ...
}
}
```
```ts title="Signature"
class RwPermissionDefinition extends PermissionDefinition {
constructor(name: string, descriptionFn?: (operation: 'read' | 'write') => string)
Read: Permission
Write: Permission
}
```
* Extends: [`PermissionDefinition`](/current/core/reference/typescript-api/auth/permission-definition#permissiondefinition)
### Read
\Permission`} />
Returns the 'Read' permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
### Write
\Permission`} />
Returns the 'Write' permission defined by this definition, for use in the
[Allow](/current/core/reference/typescript-api/request/allow-decorator#allow) decorator.
## PermissionDefinitionConfig
Configures a [PermissionDefinition](/current/core/reference/typescript-api/auth/permission-definition#permissiondefinition)
```ts title="Signature"
interface PermissionDefinitionConfig {
name: string;
description?: string;
assignable?: boolean;
internal?: boolean;
}
```
### name
\
The name of the permission. By convention this should be
UpperCamelCased.
### description
\
A description of the permission.
### assignable
\
Whether this permission can be assigned to a Role. In general this
should be left as the default `true` except in special cases.
### internal
\
Internal permissions are not exposed via the API and are reserved for
special use-cases such at the `Owner` or `Public` permissions.