Account Access Schema

User permissions and access levels for account operations

The Account Access schema defines the structure and properties of account access objects in the Payload API. Account access objects represent user permissions and access levels for specific accounts, allowing fine-grained control over account operations.

Account Access Object Properties

Complete reference for all properties available in the Account Access schema

access_level

enum[string]Immutable

The level of access the user has to this account. Possible values: full (complete access to all account features), limited (restricted access to specific features), or owner (highest level with ability to manage other users). This cannot be changed after creation; create a new access grant to modify permissions.

Values: full, limited, owner

account_id

stringRequired

The unique identifier of the account that the user can access. This can be a customer account, processing account, or organization. (ID prefix: acct)

Pattern: ^acct_[A-Za-z0-9]+$

account_name

stringRequiredRead-only

The display name of the account. This is read-only and reflects the current name of the associated account for easy reference and display.

Max length: 72

account_type

stringRequiredRead-only

The type of account being accessed. Possible values: customer, processing, org, or generic. This is read-only and helps determine what features are available.

Max length: 10

attrs

object

Custom attributes for extending the resource with additional key-value pairs. Maximum length is 255 characters when serialized.

created_at

string (date-time)Read-only

Timestamp when the resource was created. Automatically set by the system and immutable.

id

stringRead-only

Unique identifier for the resource. Automatically generated upon creation and cannot be modified. (ID prefix: aa)

Pattern: ^aa_[A-Za-z0-9]+$

modified_at

string (date-time)Read-only

Timestamp when the resource was last modified. Automatically updated whenever any field changes.

object

enum[string]Read-only

String representing the object type for this resource.

Values: account_access

user_id ID of User

stringRequired

The unique identifier of the user who has access to this account. This establishes the user-account relationship and determines what the user can see and do within the account. (ID prefix: usr)

Pattern: ^usr_[A-Za-z0-9]+$

Profile User