@startupjs/auth-lti

0.55.8 • Public • Published

Авторизация через LTI

Инициализация главного модуля

Настройка главного модуля

Требования

startupjs: >= 0.44.0
@startupjs/auth: >= 0.33.0
@startupjs/ui: >= 0.44.0
prop-types *

Инициализация на сервере

Импорт стратегии:

import { Strategy as LTIStrategy } from '@startupjs/auth-idg/server'

Импорт либы для конфига:

import conf from 'nconf'

В startupjsServer, в стратегии функции initAuth нужно добавить LTIStrategy с указанием обьекта опций:

initAuth(ee, {
  strategies: [
    new LTIStrategy(<options>)
  ]
})

Доступные опции

  callbackUrl: <string> - опционально, дефолтное значение: '/auth/lti/callback'
  dbSchools: <boolean> - опционально, дефолтное значение: false
  collectionName: <string> - опционально если dbSchools со значение false, дефолтное значение: 'authLTISchools'
  schools: <object> - опционально если dbSchools со значением true

Пример значения опции schools

{
    <school-name>: {
      consumerKey: <key>,
      consumerSecret: <secret>
    },
    ucdavis: {
      consumerKey: '12312k321l'
      consumerSecret: '312kjh3k12jh''
    },
    ....
}

Вы можете проинициализировать стратегию с предопределенными школами

{
  schools: <object>
}

или использовать школы из базы данных

{
  dbSchools: true
}

Инициализация в верстке

Отсутствует

Использование школ из базы данных

Компонент для редактирования списка школ

Этот компонент предоставляет возможность добавлять новые школы и удалять ранее добавленные

import { List } from '@dmapper/auth-lti'
...
<List />

Компонент принимает следующие опции

collection: <string> - опционально, дефолтное значение: 'authLTISchools'

Если вы нуждаетесь в другом названии коллекции для хранения школ, то вы должны указать это соответсвующей опцией в стратегии и в компоненте:

initAuth(ee, {
  strategies: [
    new LTIStrategy({
      dbScools: true,
      collectionName: 'anotherName' <---
    })
  ]
})
import { List } from '@dmapper/auth-lti'
...
<List 
  collection="anotherName" <---
/>

Configuring third party LMSs

Readme

Keywords

Package Sidebar

Install

npm i @startupjs/auth-lti

Weekly Downloads

1

Version

0.55.8

License

MIT

Unpacked Size

12 kB

Total Files

20

Last publish

Collaborators

  • cray0000
  • yska
  • zag2art
  • fctsvirus
  • maestro.sc
  • byshock