Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.83 KB

globals.mdx

File metadata and controls

56 lines (41 loc) · 1.83 KB
title label order desc keywords
Globals Access Control
Globals
40
Global-level Access Control is specified within each Global's `access` property and allows you to define which users can read or update Globals.
globals, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, express

You can define Global-level Access Control within each Global's access property. All Access Control functions accept one args argument.

**Available argument properties:

Available Controls

Function Allows/Denies Access
read Used in the findOne Global operation
update Used in the update Global operation

Example Global config:

import { GlobalConfig } from 'payload/types';

const Header: GlobalConfig = {
  slug: "header",
  // highlight-start
  access: {
    read: ({ req: { user } }) => { /* */ },
    update: ({ req: { user } }) => { /* */ },
  },
  // highlight-end
};

export default Header;

Read

Returns a boolean result or optionally a query constraint which limits who can read this global based on its current properties.

Available argument properties:

Option Description
req The Express request object containing the currently authenticated user

Update

Returns a boolean result or optionally a query constraint which limits who can update this global based on its current properties.

Available argument properties:

Option Description
req The Express request object containing the currently authenticated user
data The data passed to update the global with.