passkey : Foxy hAPI

passkeys

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Actions

GET: View a list of passkeys
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:passkeys": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/passkey">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: passkey

Description

Passkeys are an additional authentication method used at auth.foxy.io to access admin.foxy.io. Passkey creation is limited to Foxy internal processes. If you have a use case that requires creating passkeys, please reach out to discuss it with us.

Actions

GET: View a passkey
DELETE: Delete a passkey
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
credential_id	Credential ID of this passkey.	String	Read only
last_login_date	The last login date using this passkey.	String	Read Only
last_login_ua	The last login UA for this passkey.	String	Read Only
date_created	The date this passkey was created.	Date	Read only
date_modified	The date this passkey was last modified.	Date	Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.com/passkeys/5",
            "title": "This passkey"
        },
        "fx:user": {
            "href": "https://api.foxycart.com/users/123",
            "title": "Foxy user that owns this passkey"
        },
        "fx:user_passkeys": {
            "href": "https://api.foxycart.com/users/123/passkeys",
            "title": "Collection of all passkeys for authenticated User"
        }
    },
    "credential_id": "passkey_credentialId",
    "last_login_date": "2024-03-29T19:03:19-0700",
    "last_login_ua": null,
    "date_created": "2024-03-29T19:03:19-0700",
    "date_modified": "2024-03-30T06:55:53-0700"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/passkeys/5" rel="https://api.foxycart.com/rels/passkeys">
    <link rel="self" href="https://api-sandbox.foxycart.com/passkeys/5" title="This Passkey"/>
    <link rel="https://api.foxycart.com/rels/users" href="https://api-sandbox.foxycart.com/users/123" title="Foxy user that owns this passkey"/>
    <link rel="https://api.foxycart.com/rels/passkeys" href="https://api-sandbox.foxycart.com/users/123/passkeys" title="Collection of all passkeys for authenticated User"/>
    <credential_id>passkey_credentialId</credential_id>
    <last_login_date>2024-03-29T19:03:19-0700</last_login_date>
    <last_login_ua></last_login_ua>
    <date_created>2024-03-29T19:03:19-0700</date_created>
    <date_modified>2024-03-30T06:55:53-0700</date_modified>
</resource>

{
    "class": [
        "passkeys"
    ],
    "rel": [
        "https://api.foxycart.com/rels/passkeys"
    ],
    "properties": {
        "credential_id": "passkey_credentialId",
        "last_login_date": "2024-03-29T19:03:19-0700",
        "last_login_ua": null,
        "date_created": "2024-03-29T19:03:19-0700",
        "date_modified": "2024-03-30T06:55:53-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/passkeys/5"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/users"
            ],
            "href": "https://api-sandbox.foxycart.com/users/123"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/passkeys"
            ],
            "href": "https://api-sandbox.foxycart.com/users/123/passkeys"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.