Policy

Lists all policies

get/policies

Response

Successful operation

_idstring required

Document ID

updatedAtstring date-time required

Timestamp when this was last modified

createdAtstring date-time required

Timestamp when this was created

packageNamestring required

Policy NPM package name

authorWalletAddressstring required

Author wallet address. Derived from the authorization signature provided by the creator.

descriptionstring required

Policy description - displayed to users in the dashboard/Vincent Explorer UI

logostring

Base64 encoded logo image

activeVersionstring required

Active version of the policy; must be an exact semver

titlestring required

Policy title for displaying to users in the dashboard/Vincent Explorer UI

deploymentStatus'dev' | 'test' | 'prod'

Identifies if a policy is in development, test, or production.

isDeletedboolean

Whether or not this Policy is deleted

Example response

[
  {
    "packageName": "@lit-protocol/vincent-policy-spending-limit",
    "authorWalletAddress": "0x123456789012345678901234567890123456abcd",
    "description": "This policy is a foo bar policy",
    "logo": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOvwAADr8BOAVTJAAAAA5JREFUGFdj/M+ACAAAAAD//wE7AnsAAAAAAElFTkSuQmCC",
    "activeVersion": "1.0.0",
    "title": "Vincent Spending Limit Policy",
    "deploymentStatus": "dev"
  }
]

Changes

Changed in 8 of the 50 revisions of this API.2312

    • added the optional property items/logo to the response with the 200 status

      response-optional-property-added

    • added the optional property items/isDeleted to the response with the 200 status

      response-optional-property-added

    • added the optional property items/deploymentStatus to the response with the 200 status

      response-optional-property-added

    • the response required property items/authorWalletAddress became read-only for the status 200

      response-required-property-became-read-only

    • api tag Policy added

      api-tag-added

    • api tag policy removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response required property items/authorWalletAddress became not read-only for the status 200

      response-required-property-became-not-read-only

    • added the required property items/title to the response with the 200 status

      response-required-property-added

    • the response required property items/authorWalletAddress became read-only for the status 200

      response-required-property-became-read-only

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e514cea423bb233See the full diff
    • the items/description response property's minLength was decreased from 10 to 0 for the response status 200

      response-property-min-length-decreased

    • removed the required property items/title from the response with the 200 status

      response-required-property-removed

    • removed the optional property items/deploymentStatus from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/isDeleted from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/logo from the response with the 200 status

      response-optional-property-removed

    • api tag policy added

      api-tag-added

    • api tag Policy removed

      api-tag-removed

    • the response required property items/authorWalletAddress became not read-only for the status 200

      response-required-property-became-not-read-only

    This revision also has 51 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog