You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

87 lines
2.1 KiB
Groff

.\" Man page generated from reStructuredText.
.
.TH "ACCESS" "1" "Jan 10, 2023" "5.3.0" "SeisComP"
.SH NAME
access \- SeisComP Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
\fBAccess module for FDSNWS.\fP
.SH BINDINGS PARAMETERS
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBaccess.*\fP
\fIDefines access to restricted data. When defined it will add the listed users to the list of authorized users to access certain restricted data give the parameters on this binding.\fP
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B access.users
Type: \fIlist:string\fP
.sp
List of users (e\-mail addresses) allowed to access the restricted data.
.UNINDENT
.INDENT 0.0
.TP
.B access.disableStationCode
Default: \fBfalse\fP
.sp
Type: \fIboolean\fP
.sp
When disableStationCode option is set to true the access entries will be generated only for the network level (and optionally stream level), no station code will be filled (this can potentially reduce the number of entries on the access table, and save memory on the request handler when used).
.UNINDENT
.INDENT 0.0
.TP
.B access.streams
Type: \fIlist:string\fP
.sp
List of locations.streams this access rule applies to. The location code is optional (optional, allow wildcards).
.UNINDENT
.INDENT 0.0
.TP
.B access.start
Type: \fIdatetime\fP
.sp
Start of validity (optional).
.UNINDENT
.INDENT 0.0
.TP
.B access.end
Type: \fIdatetime\fP
.sp
End of validity (optional).
.UNINDENT
.SH AUTHOR
gempa GmbH, GFZ Potsdam
.SH COPYRIGHT
gempa GmbH, GFZ Potsdam
.\" Generated by docutils manpage writer.
.