Auth Registrar: User

The Auth Registrar: User Web service is used to register a user to a group. That way, the registered user will have access to the datasets accessible by the group.

Developers communicate with the Auth Registrar: User Web service using the HTTP GET method. You may request any content type (*/*).

'''No content is returned by the Web service endpoint if the endpoint successfully executed the query. Only a "200 OK" message will be returned in the header.'''

Version
This documentation page is used for the version 3 of this endpoint. Check at the top of this page to see the documentation pages for the other versions of this endpoint.

Usage
This Web service is intended to be used by content management systems, developers or administrators to manage access to WSF (Web Service Framework) resources (users, datasets, Web services endpoints).

This web service endpoint is used to register a user to a group of users to give access to that user to the datasets accessible by that group.

Read more about how the OSF Web Services access permissions works by reading this page...

Web Service Endpoint Information
This section describes all you permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.

To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.

Needed registered CRUD permission:


 * Create: True
 * Read: True
 * Update: False
 * Delete: True

As shown on the graph URI:


 * http://[...]/wsf/

Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.

''Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.''

HTTP Method:


 * GET

Possible "Accept:" HTTP header field value:



URI:


 * http://[...]/ws/auth/registrar/group/?user_uri=&group_uri=&action=&interface=&version=

URI dynamic parameters description:

Note: All parameters have to be URL-encoded


 * user_uri. URI of the user to register
 * group_uri. URI of the group where to register the user
 * action. Action to perform with this endpoint query. Can be one of:
 * "join": join the target group
 * "leave": leave the target group
 * interface. Source interface used for this web service query. The interface is a different way to process a query (different algorithms, different data management system, etc. The default interface is 'default'
 * version. (default: 3.0) Version of the interface to query

Query Answer from the Endpoint
If the query is successfully performed by the endpoint (i.e., the access resource has been properly created, updated or deleted), the endpoint will return the HTTP status message "200 OK" with an empty body. If an error occured, one of the HTTP status messages with the description of the error message in the body of the HTTP query will be returned.

Available Sources Interfaces
A source interface is a way to process a web service query. Different sources interfaces can be implemented for the same OSF Web Service endpoint. Each interface will process the query differently, but all the queries to the web service endpoint will be the same, at the exception of the  parameter. Each interface shares the same API (the one defined by the web service endpoint), but their processing may differ (like using different algorithms, using different data management systems, etc.)

This is a list of the core interfaces for this endpoint. Organizations that hosts a OSF Web Service network could create their own interface and make it available to the users. However such private source interface won't be part of this list, but should be publicized by the organization.

HTTP Status Codes
Here are the possible HTTP status (error) codes returned by this Web service endpoint.

On error code and the specific error, a different message description can be issued (meaning a different error has been returned).