Schema for Stitch Link Permission

From LinkPermission.schema.yaml (stitch/LinkPermission.schema)

---
$id: https://skeleton.botmd.io/stitch/LinkPermission.schema
$schema: http://json-schema.org/draft-07/schema#

title: Link Permission
description: Permission system for Stitch generated links. Each key represent an `application` or `provider` that will manage link creation and allow/deny.

type: object
additionalProperties: false
minProperties: 1

properties:
  cleo:
    $ref: "/cleo/StitchPermissions.schema"

  hospital:
    $ref: "/hospital/Permissions.schema"

  einstein:
    $ref: "/einstein/StitchPermissions.schema"

  faraday:
    $ref: "/faraday/StitchPermissions.schema"

  maxwell:
    $ref: "/maxwell/Permissions.schema"

  legacy:
    title: Public
    description: This permission will allow all requests.

    type: object
    additionalProperties: false
    properties:
      is_authenticated:
        title: Is Authenticated
        description: Allows authenticated users only. Defaults to `true`.

        type: boolean
    #end properties
  #end legacy

  mastermind:
    title: Mastermind
    description: This permission will allow specific authenticated Mastermind users.

    type: object
    additionalProperties: false
    required: [email]

    properties:
      email:
        title: E-mail
        description: E-mail address of Mastermind profile.
        type: string
        format: email
    #end properties

  public:
    title: Public
    description: This permission will allow all requests.

    type: object
    additionalProperties: false

  deny:
    title: Deny
    description: This permission will deny all requests.

    type: object
    additionalProperties: false

  mock:
    $ref: "/skeleton/Any.schema"
#end properties

[Main Page] [Schema Documentation] [Examples]