table of contents
DACS_LIST_JURISDICTI(8) | DACS Web Services Manual | DACS_LIST_JURISDICTI(8) |
NAME¶
dacs_list_jurisdictions - display information about DACS jurisdictionsSYNOPSIS¶
dacs_list_jurisdictions
[ dacsoptions[1]]
DESCRIPTION¶
This web service is part of the DACS suite. The dacs_list_jurisdictions web service displays information, relative to the jurisdiction that receives the request, about its federation and other jurisdictions in that federation. Included are the federation's public encryption key and its unique instance identifier. The FORMAT argument (see dacs.services(8)[2]) determines the type of output, with the default being HTML, using the style sheet dacs_list_jurisdictions.css[3]. The various flavours of XML, a PHP format (see below), JSON, and plain text (TEXT) are supported. One application of dacs_list_jurisdictions is to assist middleware to generate a menu of jurisdictions for user authentication. If FORMAT is PHP, a list of each jurisdiction that provides an authentication service is emitted (as text/plain, one jurisdiction per line. Each line has the format:jurisdiction[]= jname&host[]=url&jname
jurisdiction[]=INFOCARDS&host[]=https://example.com/infocards/cgi-bin/dacs&INFOCARDS jurisdiction[]=DEMO&host[]=https://example.com/demo/cgi-bin/dacs&DEMO jurisdiction[]=TEST&host[]=https://test.example.com/cgi-bin/dacs&TEST
Web Service Arguments¶
In addition to the standard CGI arguments[8], dacs_list_jurisdictions understands the following CGI arguments: JURISDICTIONLimit the output to the specified jurisdiction
name. As a special case, if the argument does not specify a jurisdiction name,
only federation-scoped information will be returned.
PUB_KEY_ONLY
If this argument is "yes" (case
insensitive) only the federation's or a jurisdiction's public key (if known)
will be returned. If JURISDICTION is given and is not the empty string,
that jurisdiction name is selected; if JURISDICTION is given and is the
empty string, the federation is selected; and if the argument is absent, the
current jurisdiction is selected. This argument currently requires
FORMAT to be TEXT. A PEM [ RFC 1421[9], RFC 1422[10],
RFC 1423[11], RFC 1424[12]] formatted key is returned.
FILES¶
dacs_list_jurisdictions.css[3]DIAGNOSTICS¶
The program exits 0 if everything was fine, 1 if an error occurred.SEE ALSO¶
dacs(1)[13], dacskey(1)[14], dacslist(1)[6], dacs.groups(5)[15]AUTHOR¶
Distributed Systems Software ( www.dss.ca[16])COPYING¶
Copyright2003-2012 Distributed Systems Software. See the LICENSE[17] file that accompanies the distribution for licensing information.NOTES¶
- 1.
- dacsoptions
- 3.
- dacs_list_jurisdictions.css
- 4.
- html/examples/login.php
- 5.
- dacs_list_jurisdictions.dtd
- 6.
- dacslist(1)
- 8.
- standard CGI arguments
- 9.
- RFC 1421
- 10.
- RFC 1422
- 11.
- RFC 1423
- 12.
- RFC 1424
- 13.
- dacs(1)
- 14.
- dacskey(1)
- 15.
- dacs.groups(5)
- 16.
- www.dss.ca
- 17.
- LICENSE
10/22/2012 | DACS 1.4.27b |