add initial ESSE3 collections
This commit is contained in:
@@ -0,0 +1,65 @@
|
||||
info:
|
||||
name: changeUserPassword
|
||||
type: http
|
||||
seq: 1
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: PUT
|
||||
url: "{{baseUrl}}/changeUserPassword"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: |
|
||||
il contenuto ritornato esprime il risultato dell'operazione.
|
||||
request:
|
||||
url: "{{baseUrl}}/changeUserPassword"
|
||||
method: PUT
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
- name: 401 Response
|
||||
description: l'header "Authorization" non è presente oppure contiene dati non validi o credenziali errate
|
||||
request:
|
||||
url: "{{baseUrl}}/changeUserPassword"
|
||||
method: PUT
|
||||
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>Modifica la password di un utente. Per poter accedere al servizio occorrono le credenziali di un'utenza
|
||||
tecnica passate tramite header http "Authorization: Basic ....".
|
||||
NB: l'utente deve poter utilizzare il tipo client REST ed avere abilitato l'accesso alla funzione SI_18_008.
|
||||
|
||||
|
||||
**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: common-auth-permissions**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
@@ -0,0 +1,38 @@
|
||||
info:
|
||||
name: checkLogon
|
||||
type: http
|
||||
seq: 2
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/checkLogon"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
docs: |
|
||||
Verifica le credenziali di un utente fornite tramite header http "Authorization: Basic ...."
|
||||
|
||||
|
||||
**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: common-public-permissions**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
ALL|Funzione Pubblica|Security.checkDummy()
|
||||
@@ -0,0 +1,61 @@
|
||||
info:
|
||||
name: checkSessionId
|
||||
type: http
|
||||
seq: 11
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/sessions/:sessionId/check"
|
||||
params:
|
||||
- name: sessionId
|
||||
value: ""
|
||||
type: path
|
||||
description: sessionId di backend
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/sessions/:sessionId/check"
|
||||
method: GET
|
||||
params:
|
||||
- name: sessionId
|
||||
value: ""
|
||||
type: path
|
||||
description: sessionId di backend
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>controlla se il sessionId passato in ingresso è valido, nel caso non sia valido viene restituito 404
|
||||
|
||||
|
||||
**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: user-tecnico-permissions**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
UTENTE_TECNICO|funzione accessibile alle utenze tecniche per accessi ai servizi REST|Security.checkUserTecnico()
|
||||
@@ -0,0 +1,7 @@
|
||||
info:
|
||||
name: autenticazione
|
||||
type: folder
|
||||
seq: 1
|
||||
|
||||
request:
|
||||
auth: inherit
|
||||
@@ -0,0 +1,51 @@
|
||||
info:
|
||||
name: getCacheParams
|
||||
type: http
|
||||
seq: 4
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/login/cache/"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/login/cache/"
|
||||
method: GET
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>recupea le informazioni sulle cache abilitate per la sessione
|
||||
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
@@ -0,0 +1,157 @@
|
||||
info:
|
||||
name: getCurrentSession
|
||||
type: http
|
||||
seq: 10
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/sessions/current-session"
|
||||
params:
|
||||
- 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
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/sessions/current-session"
|
||||
method: GET
|
||||
params:
|
||||
- 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}}/sessions/current-session"
|
||||
method: GET
|
||||
params:
|
||||
- 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}}/sessions/current-session"
|
||||
method: GET
|
||||
params:
|
||||
- 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>controlla se il sessionId passato in ingresso è valido, nel caso non sia valido viene restituito 404
|
||||
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
|
||||
|
||||
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
|
||||
@@ -0,0 +1,63 @@
|
||||
info:
|
||||
name: getJWT
|
||||
type: http
|
||||
seq: 6
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/login/jwt/new"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/login/jwt/new"
|
||||
method: GET
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera il token JWT rilasciato da esse3 relativo alla sessione utente già autenticata
|
||||
|
||||
La pagina di recupero delle chiavi per la validazione del token è reperibile sulla installazione di webesse3
|
||||
all'indirizzo <webesse3.url>/jwt/jwk.do
|
||||
|
||||
Il token rilasciato contiene i seguenti claim
|
||||
* sub (secondo il par_cond OAUTH_USER_CLAIM)
|
||||
* iss = esse3
|
||||
* iat = epoch di generazione del token
|
||||
* exp = epoch di expire del token configurata nel gruppo utente
|
||||
* profile = profillo dell'utente
|
||||
* fiscalCode = codice Fiscale dell'utente
|
||||
* tenant = tenant dell'installazione
|
||||
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
@@ -0,0 +1,52 @@
|
||||
info:
|
||||
name: getLinguaCod
|
||||
type: http
|
||||
seq: 7
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/login/lingua"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/login/lingua"
|
||||
method: GET
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Recupera la lingua impostata nella sessione utente. Questa lingua viene utilizzata nelle operazioni get per
|
||||
effettaure i recuperi delle descrizioni nella lingua selezionata (dove previsto)
|
||||
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
@@ -0,0 +1,180 @@
|
||||
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
|
||||
|
||||
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
|
||||
@@ -0,0 +1,50 @@
|
||||
info:
|
||||
name: logout
|
||||
type: http
|
||||
seq: 9
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: GET
|
||||
url: "{{baseUrl}}/logout"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/logout"
|
||||
method: GET
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Effettua la logout da esse3.
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
@@ -0,0 +1,72 @@
|
||||
info:
|
||||
name: setCacheParams
|
||||
type: http
|
||||
seq: 5
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: PUT
|
||||
url: "{{baseUrl}}/login/cache/"
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/login/cache/"
|
||||
method: PUT
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
- name: 422 Response
|
||||
description: Aggiornamento non riuscito
|
||||
request:
|
||||
url: "{{baseUrl}}/login/cache/"
|
||||
method: PUT
|
||||
response:
|
||||
status: 422
|
||||
statusText: Unprocessable Entity
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Imposta le cache da abiltiare/disabilitare per la sessione utente
|
||||
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
|
||||
|
||||
Classe di modello : DettaglioErroreAggiuntivo
|
||||
======
|
||||
|
||||
Estensioni sulle proprietà
|
||||
----
|
||||
Proprietà | x-field-type
|
||||
-|-|
|
||||
rawValue|rawJson
|
||||
@@ -0,0 +1,64 @@
|
||||
info:
|
||||
name: setLinguaCod
|
||||
type: http
|
||||
seq: 8
|
||||
tags:
|
||||
- autenticazione
|
||||
|
||||
http:
|
||||
method: PUT
|
||||
url: "{{baseUrl}}/login/lingua"
|
||||
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
|
||||
auth: inherit
|
||||
|
||||
settings:
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
followRedirects: true
|
||||
maxRedirects: 5
|
||||
|
||||
examples:
|
||||
- name: 200 Response
|
||||
description: Successful response
|
||||
request:
|
||||
url: "{{baseUrl}}/login/lingua"
|
||||
method: PUT
|
||||
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
|
||||
response:
|
||||
status: 200
|
||||
statusText: OK
|
||||
body:
|
||||
type: text
|
||||
data: ""
|
||||
|
||||
docs: |
|
||||
<span class="e3rest-operation-auth-img-list"><img src="basic.png"/><img src="jwt.png"/></span>Aggiorna la lingua di sessione. Questa lingua viene utilizzata nelle operazioni get per
|
||||
effettaure i recuperi delle descrizioni nella lingua selezionata (dove previsto)
|
||||
|
||||
|
||||
**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: AUTHENTICATED**
|
||||
|
||||
Profilo|Controllo| Funzione
|
||||
-|-|-
|
||||
AUTENTICATO|Funzione riservata a tutti gli utenti autenticati|Security.checkAuthUser()
|
||||
Reference in New Issue
Block a user