api-collections/bruno/collections/ESSE3 Common Auth API/autenticazione/login.yml

info:
  name: login
  type: http
  seq: 3
  tags:
    - autenticazione

http:
  method: GET
  url: "{{baseUrl}}/login"
  params:
    - name: sessionLinguaCod
      value: ""
      type: query
      description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default
      disabled: true
    - name: optionalFields
      value: ""
      type: query
      description: |
        specifica la lista dei campi opzionali (che non vengono recupeati di default);
        impostando il valore `ALL` vengono mostrati tutti i campi. 

        Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*  
        I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)

        Esempi
        * per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
        * Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
        * Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
      disabled: true
  auth: inherit

settings:
  encodeUrl: true
  timeout: 0
  followRedirects: true
  maxRedirects: 5
  forwardAuthorizationHeader: true

examples:
  - name: 200 Response
    description: Successful response
    request:
      url: "{{baseUrl}}/login"
      method: GET
      params:
        - name: sessionLinguaCod
          value: ""
          type: query
          description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default
          disabled: true
        - name: optionalFields
          value: ""
          type: query
          description: |
            specifica la lista dei campi opzionali (che non vengono recupeati di default);
            impostando il valore `ALL` vengono mostrati tutti i campi. 

            Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*  
            I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)

            Esempi
            * per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
            * Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
            * Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
          disabled: true
    response:
      status: 200
      statusText: OK
      body:
        type: text
        data: ""
  - name: 300 Response
    description: Più profili disponibili, rieffettuare la login aggiungendo l'header X-Esse3-User-Profile, indicando come valore STUDENTE, DOCENTE o USER_TECNICO
    request:
      url: "{{baseUrl}}/login"
      method: GET
      params:
        - name: sessionLinguaCod
          value: ""
          type: query
          description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default
          disabled: true
        - name: optionalFields
          value: ""
          type: query
          description: |
            specifica la lista dei campi opzionali (che non vengono recupeati di default);
            impostando il valore `ALL` vengono mostrati tutti i campi. 

            Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*  
            I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)

            Esempi
            * per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
            * Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
            * Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
          disabled: true
    response:
      status: 300
      statusText: Multiple Choice
      body:
        type: text
        data: ""
  - name: 401 Response
    description: login failed
    request:
      url: "{{baseUrl}}/login"
      method: GET
      params:
        - name: sessionLinguaCod
          value: ""
          type: query
          description: codice ISO_6392 della lingua con la quale recuperare le descrizioni, nel caso non sia passato in ingresso viene utilizzata la lingua di default del sistema, e nel caso la lingua richiesta non sia disponibile, viene restituita la descrizione nella lingua di default
          disabled: true
        - name: optionalFields
          value: ""
          type: query
          description: |
            specifica la lista dei campi opzionali (che non vengono recupeati di default);
            impostando il valore `ALL` vengono mostrati tutti i campi. 

            Per gli oggetti è possibile utilizzare la notazione *Ant Glob Patterns*  
            I dettagli sono presenti [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Filtrosuicampidelleclassidimodello)

            Esempi
            * per il campo childObj con la poprietà childProp utilizzare la notazione `childProp.prop1`
            * Per visualizzare tutte le proprietà di childObj utilizzare la notazione `childProp.*`
            * Per visualizzare tutte le proprietà di childObj e di tutti i discendenti utilizzare la notazione `childProp.**`
          disabled: true
    response:
      status: 401
      statusText: Unauthorized
      body:
        type: text
        data: ""

docs: |
  <span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua la login ad esse3.
  E' possibile richiedere una tipologia specifica di profilo utente tramite l'header HTTP X-Esse3-User-Profile, indicando come valore STUDENTE, DOCENTE o USER_TECNICO
  Nel caso di utenza con più profili (e accesso tramite codice fiscale) viene ritornato lo status code 300 e *NON* viene effettauta la login.
  Occorre come indicato rieffettuare la chiamata aggiungendo uno dei profili disponibili   


  **Estensioni:**

  Codice Estensione|Valore|Nota
  -|-|-
  x-cache-type|noCache|Nessuna cache impostata Maggiori dettagli [qui](https://wiki.u-gov.it/confluence/display/ESSE3/Servizi+REST+su+ESSE3#ServiziRESTsuESSE3-Cachingdellerichieste) 


  **Controlli di sicurezza:**
  ======
  _Nota: Il controllo per utente è verificato quando viene passato almeno uno dei controlli previsti_

  **Utente: ALL**

  Profilo|Controllo| Funzione
  -|-|-
  ALL|Funzione Pubblica|Security.checkDummy()


  Classe di modello : SessioneUtente
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  jwt|optional


  Classe di modello : SessioneUtente
  ======

  Estensioni sulle proprietà
  ----
  Proprietà | x-field-type
  -|-|
  jwt|optional