Auth Registrar: Group

From OSF Wiki
Jump to: navigation, search
Auth Registrar: Group endpoint version:
3

The Auth Registrar: Group Web service is used to create or delete group(s) of users that may be granted access rights (using other services) to records.

Developers communicate with the Auth Registrar: Group Web service using the HTTP GET method. You may request any available 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 create what we refer to as a user 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/?group_uri=&app_id=&action=&interface=&version=

URI dynamic parameters description:

Note: All parameters have to be URL-encoded

  • group_uri. URI of the group to create
  • app_id. ID of the application where the group belongs to
  • action. Action to perform with this endpoint query. Can be one of:
    • "create": create a new group
    • "delete": delete an existing 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 interface 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.


Source Interface Name Description
default Default source interface for this OSF Web Service endpoint. This interface implements the default behavior of this OSF Web Service endpoint.


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).


HTTP 200

Message Description
OK


HTTP 400

ID Level Name Description
WS-AUTH-REGISTRAR-GROUP-200 Warning No Group URI No group URI defined for this query.
WS-AUTH-REGISTRAR-GROUP-201 Warning No APP ID No APP ID defined for this query.
WS-AUTH-REGISTRAR-GROUP-202 Fatal Can't check if the group was already registered to this WSF An error occured when we tried to check if the group was already registered to this web service network.
WS-AUTH-REGISTRAR-GROUP-203 Fatal Group already registered The group is already registered to this web service network.
WS-AUTH-REGISTRAR-GROUP-204 Fatal Unexisting action An unexisting action as been specified. The action parameter can be one of: (1) create, or (2) delete
WS-AUTH-REGISTRAR-GROUP-300 Fatal Couldn't register group An internal error occured when we tried to register this group to the web service network.
WS-AUTH-REGISTRAR-GROUP-301 Fatal Requested source interface not existing The source interface you requested is not existing for this web service endpoint.
WS-AUTH-REGISTRAR-GROUP-302 Fatal Requested incompatible Source Interface version The version of the source interface you requested is not compatible with the version of the source interface currently hosted on the system. Please make sure that your tool get upgraded for using this current version of the endpoint.
WS-AUTH-REGISTRAR-GROUP-303 Fatal Source Interface's version not compatible with the web service endpoint's The version of the source interface you requested is not compatible with the one of the web service endpoint. Please contact the system administrator such that he updates the source interface to make it compatible with the new endpoint version.
WS-AUTH-REGISTRAR-GROUP-304 Fatal Couldn't delete group An internal error occured when we tried to delete this group to the web service network.
WS-AUTH-REGISTRAR-GROUP-305 Warning Invalid group URI The URI of the group is not valid.

HTTP 403

ID Level Name Description
WS-AUTH-VALIDATION-100 Fatal Unauthorized Request Your request cannot be authorized for this web service call
WS-AUTH-VALIDATION-101 Fatal Unauthorized Request Your request cannot be authorized for this web service call
WS-AUTH-VALIDATION-102 Fatal Couldn't authorize request An internal error occured when we tried to authorize this request
WS-AUTH-VALIDATION-103 Fatal Unauthorized Request Your request cannot be authorized for this user: "---", on this dataset: "---", using this web service endpoint: "---"


HTTP 406

Message Description
Not Acceptable Unacceptable mime type requested


HTTP 500

Message Description
Internal Error