user_access

Collection: user_accesses

This resource represents a relationship between a FoxyCart store and the FoxyCart admin user who can access that store. Each user can only have one default store.

Required Scopes

Full store_full_access
Read store_user_accesses_read
Write store_user_accesses_write

Actions

GET View a user access
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

user_uri String

A full API URI of the user resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids.

store_uri String

A full API URI of the store resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids.

is_default_store Boolean

Set this to true to make this store the default store for this user. That means it will be the first store they see when they log in to the FoxyCart admin.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (3)

self This User Access
fx:store GET PATCH PUT DELETE This Store
fx:user GET PATCH PUT DELETE This User
https://api.foxycart.com/user_accesses/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/user_accesses/123",
      "title": "This User Access"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:user": {
      "href": "https://api.foxycart.com/users/999",
      "title": "This User"
    }
  },
  "user_uri": "https://api.foxycart.com/users/1",
  "store_uri": "https://api.foxycart.com/stores/66",
  "is_default_store": true,
  "date_created": "2012-02-06T14:29:36-0800",
  "date_modified": "2012-02-06T14:29:36-0800"
}