.\" Copyright (c) 2003-2012
.\" Distributed Systems Software.  All rights reserved.
.\" See the file LICENSE for redistribution information.
.\" $Id: copyright-nr 2564 2012-03-02 00:17:08Z brachman $
'\" t
.\"     Title: dacs_group
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/19/2019
.\"    Manual: DACS Web Services Manual
.\"    Source: DACS 1.4.40
.\"  Language: English
.\"
.TH "DACS_GROUP" "8" "02/19/2019" "DACS 1.4.40" "DACS Web Services Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dacs_group \- \fBDACS\fR group administration
.SH "SYNOPSIS"
.HP \w'\fBdacs_group\fR\ 'u
\fBdacs_group\fR [\fI\m[blue]\fBdacsoptions\fR\m[]\&\s-2\u[1]\d\s+2\fR]
.SH "DESCRIPTION"
.PP
This web service is part of the
\fBDACS\fR
suite\&.
.PP
The
\fBdacs_group\fR
web service displays
\fBDACS\fR
group definitions and membership and performs administrative functions on them\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.PP
This web service may eventually be replaced by the
\m[blue]\fBdacs_admin(8)\fR\m[]\&\s-2\u[2]\d\s+2
web service\&.
.sp .5v
.RE
.SS "Web Service Arguments"
.PP
Besides the
\m[blue]\fBstandard CGI arguments\fR\m[]\&\s-2\u[3]\d\s+2,
\fBdacs_group\fR
understands the following CGI arguments:
.PP
\fIOPERATION\fR
.RS 4
This argument is required and selects one of the following functions\&. Additional arguments, if any, are function\-dependent\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SHOW_GROUP_MEMBERSHIP
.sp
Arguments:
\fIGROUP_NAME\fR,
\fIJURISDICTION\fR
(\fIoptional\fR)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
LIST_GROUPS
.sp
Arguments:
\fIJURISDICTION\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SHOW_GROUP_DEFINITION
.sp
Arguments:
\fIGROUP_NAME\fR,
\fIJURISDICTION\fR
(\fIoptional\fR)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SHOW_ROLES
.sp
Display the roles associated with the caller\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
TEST_GROUP_MEMBERSHIP
.sp
Test whether the caller is in the group specified by
\fIGROUP\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
LIST_GROUP_MEMBERSHIP
.sp
Show which groups user
\fIMEMBER_NAME\fR
belongs to, as known by the receiving jurisdiction\&.
\fIMATCH_JURISDICTION\fR
(\fIoptional\fR) can be set to limit testing to those groups defined by the given jurisdiction\&.
\fIMATCH_GROUP_NAME\fR
(\fIoptional\fR) can be set to a regular expressions, applied to each known group name from any jurisdiction, to limit testing to those groups that match the given regex\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CREATE_GROUP
.sp
Arguments:
\fIGROUP_NAME\fR,
\fIGROUP_TYPE\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
DELETE_GROUP
.sp
Arguments:
\fIGROUP_NAME\fR,
\fIMEMBER_NAME\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ADD_GROUP_MEMBER
.sp
Arguments:
\fIGROUP_NAME\fR,
\fIMEMBER_NAME\fR,
\fIMEMBER_TYPE\fR,
\fIDACS\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
DELETE_GROUP_MEMBER
.sp
Arguments:
\fIGROUP_NAME\fR,
\fIMEMBER_NAME\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
PURGE_GROUP
.sp
Delete the specified cached group definition\&.
\fIJURISDICTION\fR,
\fIGROUP_NAME\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CHANGE_GROUP_DEFINITION
.sp
Arguments:
\fIGROUP_NAME\fR,
\fINEW_GROUP_NAME\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
RECEIVE_GROUP_DEFINITION
.sp
The jurisdiction receiving the request is being asked to cache one or more group definitions, passed as a
groups
element (\m[blue]\fBgroups\&.dtd\fR\m[]\&\s-2\u[4]\d\s+2) that is the value of
\fIGROUPS\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
SEND_GROUP_DEFINITION
.sp
Reply with one or more group definitions (master or cached copies)\&.
\fIGROUP_NAME_LIST\fR
is a comma\-separated list of group names\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
APPLY_DELTAS
.RE
.sp
.RE
.SH "DIAGNOSTICS"
.PP
The program exits
0
if everything was fine,
1
if an error occurred\&.
.SH "SEE ALSO"
.PP
\m[blue]\fBdacs(1)\fR\m[]\&\s-2\u[5]\d\s+2,
\m[blue]\fBdacs\&.groups(5)\fR\m[]\&\s-2\u[6]\d\s+2,
\m[blue]\fBregex(3)\fR\m[]\&\s-2\u[7]\d\s+2
.SH "AUTHOR"
.PP
Distributed Systems Software (\m[blue]\fBwww\&.dss\&.ca\fR\m[]\&\s-2\u[8]\d\s+2)
.SH "COPYING"
.PP
Copyright \(co 2003\-2018 Distributed Systems Software\&. See the
\m[blue]\fBLICENSE\fR\m[]\&\s-2\u[9]\d\s+2
file that accompanies the distribution for licensing information\&.
.SH "NOTES"
.IP " 1." 4
dacsoptions
.RS 4
\%http://dacs.dss.ca/man/dacs.1.html#dacsoptions
.RE
.IP " 2." 4
dacs_admin(8)
.RS 4
\%http://dacs.dss.ca/man/dacs_admin.8.html
.RE
.IP " 3." 4
standard CGI arguments
.RS 4
\%http://dacs.dss.ca/man/dacs.services.8.html#standard_cgi_args
.RE
.IP " 4." 4
groups.dtd
.RS 4
\%http://dacs.dss.ca/man/../dtd-xsd/groups.dtd
.RE
.IP " 5." 4
dacs(1)
.RS 4
\%http://dacs.dss.ca/man/dacs.1.html
.RE
.IP " 6." 4
dacs.groups(5)
.RS 4
\%http://dacs.dss.ca/man/dacs.groups.5.html
.RE
.IP " 7." 4
regex(3)
.RS 4
\%https://www.freebsd.org/cgi/man.cgi?query=regex&apropos=0&sektion=3&manpath=FreeBSD+10.3-RELEASE&format=html
.RE
.IP " 8." 4
www.dss.ca
.RS 4
\%http://www.dss.ca
.RE
.IP " 9." 4
LICENSE
.RS 4
\%http://dacs.dss.ca/man/../misc/LICENSE
.RE