Protocol

App Authorization Record

Authorization scope granted by the user to an application.

{
  "app": {...},
  "scope_grant": {...}
}

A private Record­ created as a result of the authorization flow.

Properties

Notes

  • The App Authorization record is created by the server.

  • The granted scope may differ from what was requested by the application.

Properties

  • read RecordLink[] optional

    • Record types allowed to be read.
  • write RecordLink[] optional

    • Record types allowed to be written.
  • subscribe RecordLink[] optional

    • Record types allowed to subscribe to.
  • import RecordLink[] optional

    • Record types allowed to be imported.
  • notify RecordLink[] optional

    • Record types the application will be notified about (webhook).

This is what the full content of an App Authorization record might look like.

{
  "app": {
    "entity": "sean.baq.run",
    "record_id": "13051c3b8913490489f4889421c2a23c"
  },
  "scope_request": {
    "read": [
      {
        "entity": "types.baq.dev",
        "record_id": "6ee7f69a90154b849bac528daa942bcd"
      }
    ],
    "write": [
      {
        "entity": "types.baq.dev",
        "record_id": "6ee7f69a90154b849bac528daa942bcd"
      }
    ],
    "subscribe": [
      {
        "entity": "types.baq.dev",
        "record_id": "6ee7f69a90154b849bac528daa942bcd"
      }
    ]
  }
}
© 2024 Quentez