Users and Groups

Organisation of security users and groups
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/rest/security
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

UserGroup

UserGroup

Up
delete /usergroup/group/{group}
Delete a group (groupDefaultDelete)
Delete a group in the default user/group service.

Path parameters

group (required)
Path Parameter — the name of the group

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

OK

Up
post /usergroup/group/{group}
Add a group (groupDefaultPost)
Add a group in the default user/group service.

Path parameters

group (required)
Path Parameter — the name of the group

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

OK

Up
get /usergroup/group/{group}/users
Query all users for a group (groupDefaultUserGet)
Query all users for a group in the default user/group service.

Path parameters

group (required)
Path Parameter — the name of the group

Return type

Users

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Users

Up
delete /usergroup/service/{serviceName}/group/{group}
Delete a group (groupDelete)
Delete a group in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
group (required)
Path Parameter — the name of the group

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

OK

Up
post /usergroup/service/{serviceName}/group/{group}
Add a group (groupPost)
Add a group in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
group (required)
Path Parameter — the name of the group

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

OK

Up
get /usergroup/service/{serviceName}/group/{group}/users
Query all users for a group (groupUserGet)
Query all users for a group in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
group (required)
Path Parameter — the name of the group

Return type

Users

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Users

Up
get /usergroup/groups/
Query all groups (groupsDefaultGet)
Query all groups in the default user/group service.

Return type

Groups

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Groups

Up
get /usergroup/service/{serviceName}/groups/
Query all groups (groupsGet)
Query all groups in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the group group service

Return type

Groups

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Groups

Up
delete /usergroup/user/{user}
Delete a user (userDefaultDelete)
Delete a user in the default user/group service.

Path parameters

user (required)
Path Parameter — the name of the user

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

OK

Up
get /usergroup/user/{user}/groups
Query all groups for a user (userDefaultGroupGet)
Query all groups for a user in the default user/group service.

Path parameters

user (required)
Path Parameter — the name of the user

Return type

Groups

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Groups

Up
post /usergroup/user/{user}
Modify a user (userDefaultPost)
Modify a user in the default user/group service, unspecified fields remain unchanged.

Path parameters

user (required)
Path Parameter — the name of the user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

userDefaultPostBody User (required)
Body Parameter — the new user's details

Responses

200

OK

Up
delete /usergroup/service/{serviceName}/user/{user}
Delete a user (userDelete)
Delete a user in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
user (required)
Path Parameter — the name of the user

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

OK

Up
delete /usergroup/user/{user}/group/{group}
Unassociate a user from a group (userGroupDefaultDelete)
Unassociate a user from a group in the default user/group service.

Path parameters

user (required)
Path Parameter — the name of the user
group (required)
Path Parameter — the name of the group

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

Up
post /usergroup/user/{user}/group/{group}
Associate a user with a group (userGroupDefaultPost)
Associate a user with a group in the default user/group service.

Path parameters

user (required)
Path Parameter — the name of the user
group (required)
Path Parameter — the name of the group

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

Up
delete /usergroup/service/{serviceName}/user/{user}/group/{group}
Unassociate a user from a group (userGroupDelete)
Unassociate a user from a group in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
user (required)
Path Parameter — the name of the user
group (required)
Path Parameter — the name of the group

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

Up
get /usergroup/service/{serviceName}/user/{user}/groups
Query all groups for a user (userGroupGet)
Query all groups for a user in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
user (required)
Path Parameter — the name of the user

Return type

Groups

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Groups

Up
post /usergroup/service/{serviceName}/user/{user}/group/{group}
Associate a user with a group (userGroupPost)
Associate a user with a group in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
user (required)
Path Parameter — the name of the user
group (required)
Path Parameter — the name of the group

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

Up
post /usergroup/service/{serviceName}/user/{user}
Modify a user (userPost)
Modify a user in a particular user/group service, unspecified fields remain unchanged.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service
user (required)
Path Parameter — the name of the user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

userPostBody User (required)
Body Parameter — the new user's details

Responses

200

OK

Up
get /usergroup/users/
Query all users (usersDefaultGet)
Query all users in the default user/group service.

Return type

Users

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Users

Up
post /usergroup/users/
Add a new user (usersDefaultPost)
Add a new user to the default user/group service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

usersDefaultPostBody User (required)
Body Parameter — the new user's details

Responses

201

Created

Up
get /usergroup/service/{serviceName}/users/
Query all users (usersGet)
Query all users in a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service

Return type

Users

Example data

Content-Type: application/xml
null

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Users

Up
post /usergroup/service/{serviceName}/users/
Add a new user (usersPost)
Add a new user to a particular user/group service.

Path parameters

serviceName (required)
Path Parameter — the name of the user/group service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

usersPostBody User (required)
Body Parameter — the new user's details

Responses

201

Created

Models

[ Jump to Methods ]

Table of Contents

  1. Group - group
  2. Groups - groups
  3. User - user
  4. Users - users

Group - group Up

Groups - groups Up

User - user Up

userName (optional)
password (optional)
enabled (optional)

Users - users Up