Custom
An AccessGrant captures ownership of a MetafieldDefinition, MetafieldNamespace, or MetaObject. A Grant can be addressed to a Role by role name, a Client by GID, or a Namespace/MetaObject by key.
Grant Types: Absolute Path: {granteeId: "gid://shopify/Client/1234", grant: READ}. Relative Path: {grantee: "my-namespace-key", grant: READ}. Role Based Access: {role: ROLE_BASED_CLIENT_GROUP, grant: READ}.
Anchor to Possible typesPossible types
- CustomDataAbsoluteAccessGrantType (CustomDataAbsoluteAccessGrantType)
- CustomDataRelativeAccessGrantType (CustomDataRelativeAccessGrantType)
- CustomDataRoleBasedAccessGrantType (CustomDataRoleBasedAccessGrantType)
- •OBJECT
Defines an AccessGrant by absolute path using Global Identifier (GID) to represent access to a Custom Data Primitive.
- Anchor to grantgrant•Custom
Data Access Permission Type! non-null Level of Access: (READ, WRITE, ADMIN).
- Anchor to granteeIdgrantee•String!
Id non-null GID for a Client.
- •OBJECT
Defines an AccessGrant by relative path using a key a Client has access to, to represent access to a Custom Data Primitive.
- Anchor to grantgrant•Custom
Data Access Permission Type! non-null Level of Access: (READ, READ_WRITE, ADMIN).
- Anchor to granteegrantee•String!non-null
Key of Namespace or MetaObject in your schema.
- •OBJECT
TK
- Anchor to grantgrant•Custom
Data Access Permission Type! non-null Level of Access: (READ, READ_WRITE/WRITE, ADMIN).
- Anchor to rolerole•String!non-null
GID for Client Role Group.
Anchor to Fields with this unionFields with this union
- •OBJECT
Access for Shop Custom Data primitives is composed of AccessGrants and/or a default permission that applies to any client using the API.