Globals Access Control

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:

1import { GlobalConfig } from 'payload/types'
2
3const Header: GlobalConfig = {
4  slug: 'header',
5  access: {
6    read: ({ req: { user } }) => {
7      /* */
8    },
9    update: ({ req: { user } }) => {
10      /* */
11    },
12  },
13}
14
15export 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.

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

Globals Access Control

Available Controls

Read

Update

Hooks Overview