Skip to main content
Anchor to CustomDataAccessPermissionType

CustomDataAccessPermissionType

enum

Permission Enum that defines level of access to a definition or namespaces a client has.

Anchor to Valid valuesValid values

Anchor to ADMINADMIN
  • Allows a client to share the field with other clients
  • Allows a client to write or edit data stored in the field on users
  • Allows a client to read data stored in the field on users
  • Allows a client to alias its own keys

If on a Metafield Namespace:

  • Allows a client to share (or revoke) the namespace with other clients
  • Allows a client to delete the namespace (member primitives are not deleted)
  • Allows a client access to any primitive in the namespace at the same level of access given to the namespace
Anchor to READREAD
  • Allows a client to read data stored in the field on users
  • Allows a client to alias its own keys

If on a Metafield Namespace:

  • Allows a client access to any primitive in the namespace at the same level of access given to the namespace
Anchor to READ_WRITEREAD_WRITE

Aliased to 'WRITE'

Anchor to WRITEWRITE
  • Allows a client to write or edit data stored in the field on users
  • Allows a client to read data stored in the field on users
  • Allows a client to alias its own keys

If on a Metafield Namespace:

  • Allows a client to share (or revoke) primitives into the namespace.
  • Allows a client access to any primitive in the namespace at the same level of access given to the namespace
Was this section helpful?

Anchor to FieldsFields

Anchor to CustomDataAbsoluteAccessGrantType.grantCustomDataAbsoluteAccessGrantType.grant
•OBJECT

Defines an AccessGrant by absolute path using Global Identifier (GID) to represent access to a Custom Data Primitive.

Anchor to CustomDataAccessGrantInput.grantCustomDataAccessGrantInput.grant
•INPUT OBJECT

Defines a single AccessGrant which is one_of(granteeId, grantee, or role) and a grant.

Anchor to CustomDataAccessInput.defaultCustomDataAccessInput.default
•INPUT OBJECT

Access for Shop Custom Data primitives is composed of AccessGrants and/or a default permission that applies to any client using the API.

AccessInput defines a set of AccessGrants and/or a default permission level.

Anchor to CustomDataAccessType.defaultCustomDataAccessType.default
•OBJECT

Access for Shop Custom Data primitives is composed of AccessGrants and/or a default permission that applies to any client using the API.

Anchor to CustomDataRelativeAccessGrantType.grantCustomDataRelativeAccessGrantType.grant
•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 CustomDataRoleBasedAccessGrantType.grantCustomDataRoleBasedAccessGrantType.grant
•OBJECT

TK

Was this section helpful?