provider-schema.yaml

---

$schema: http://json-schema.org/schema#
$id: https://gitlab.com/openmicroscopy/incubator/omero-oauth#0
title: jsonschema for provider configuration file
type: object
additionalProperties: false
required:
  - providers
properties:
  providers:
    title: List of OAuth provider configurations
    type: array
    minItems: 1
    items:
      type: object
      additionalProperties: false
      required:
        - name
        - displayname
        - url
        - client
        - userinfo
        - user
      properties:

        name:
          title: provider short name used for URLs and variables
          type: string
          pattern: "^[a-z][a-z0-9]+$"

        displayname:
          title: Provider name shown to users
          type: string

        url:
          type: object
          additionalProperties: false
          required:
            - callback
          properties:
            authorisation:
              title: Provider authorisation URL, optional if openid.issuer defined
              type: string
            token:
              title: Provider token URL, optional if openid.issuer defined
              type: string
            userinfo:
              title: Provider userinfo URL, optional if openid.issuer defined
              type: string
            callback:
              title: Provider callback to this web app
              description: >
                The OMERO.web server address followed by /oauth/callback/{name} where {name} is the provider shortname defined above.
                For example, https://omero.example.org/oauth/callback/name.
                Most providers require this callback defined here to exactly match the callback configured in the provider settings.
              type: string

        client:
          type: object
          additionalProperties: false
          required:
            - id
          properties:
            id:
              title: Client ID, see your Oauth provider settings
              type: string
            secret:
              title: Client secret, see your Oauth provider
              type: string
            scopes:
              type: array
              title: List of provider-specific scopes
              items:
                type: string

        openid:
          type: object
          additionalProperties: false
          required:
            - issuer
          properties:
            issuer:
              title: The OpenID issuer, required for autoconfiguration and verification
              description: >
                If you are using autoconfiguration to obtain urls of for verification this must be provided
              type: string
            verify:
              title: If true verify the Oauth token
              description: >
                This default to false since the token is supplied over https so a verification step is redundant
              type: boolean

        authorization:
          type: object
          additionalProperties: false
          properties:
            params:
              title: Additional key-value properties for authorisation
              type: object

        userinfo:
          type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              title: The name of the userinfo parser, for example "default"
              type: string

        user:
          title: variables used to fill in new OMERO user fields
          description: >
            These properties contain `{template}` variables which will be filled using the fields in the JSON response from the userinfo calls.
            Any field in the response can be used in a template when `userinfo.type: default`.
            Some of these properties are ignored for other values of `userinfo.type`.

          type: object
          additionalProperties: false
          properties:
            name:
              title: OMERO user name template
              type: string
            email:
              title: email address template
              type: string
            firstname:
              title: Firstname template
              type: string
            lastname:
              title: Lastname template
              type: string