Skip to content

Commit ec87b77

Browse files
committed
Update README
1 parent 6727f3c commit ec87b77

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# CAS Survey Login
1+
# CAS Authenticator
22

3-
This REDCap External Module enables the integration of CAS authentication in any survey.
3+
This REDCap External Module enables the integration of CAS authentication in any survey, public report, or public dashboard.
44

55
## Installation
66

@@ -14,9 +14,14 @@ Install by downloading the latest release zip and unzipping in the modules direc
1414
- **CAS Context**: Context of the CAS Server (e.g., `/cas`)
1515
- **CAS Port**: Port of your CAS server (e.g., `443`)
1616
- **CAS Server CA Cert File**: The PEM file containing your CAS server's cert (e.g., [cacert.pem](https://curl.se/docs/caextract.html))
17-
17+
- **HTTPS Override**: Check this if you experience the CAS server redirecting to http despite your REDCap server using https protocol.
18+
-
1819
#### Project configuration:
1920

21+
- **Enable logging**: Check this to enable logging of CAS authentication events in the project's logging module
2022
- **Survey subsettings** (repeatable)
21-
- **Survey**: The survey instrument CAS should be integrated with
22-
- **ID Field**: Optional. This allows the EM to store the username of the person who authenticated. It should be a text field on the survey defined above
23+
- **Event**: The specific event in which the CAS authentication should be enabled (leave blank to apply to all events)
24+
- **Survey**: The survey instrument CAS should be integrated with
25+
- **ID Field**: Optional. This allows the EM to store the username of the person who authenticated. It should be a text field on the survey defined above
26+
- **Report**: The public report CAS should be integrated with (repeatable)
27+
- **Dashboard**: The public dashboard CAS should be integrated with (repeatable)

0 commit comments

Comments
 (0)