Auth Registrar: WS

From OSF Wiki
Jump to: navigation, search
Auth Registrar: WS endpoint version:
1.1
2
3

The Auth Registrar: WS Web service is used to register a Web service endpoint to an OSF Web Services instance. Once a Web service is registered to a WSF, it can then be used by other Web services, become accessible to users, etc.

Developers communicate with the Auth Registrar: WS 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).

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: False

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/ws/?title=&endpoint=&crud_usage=&ws_uri=&interface=&version=

URI dynamic parameters description:

Note: All parameters have to be URL-encoded

  • title. Title of the web service to register
  • endpoint. URL of the endpoint where to send the HTTP queries
  • crud_usage. A quadruple with a value "True" or "False" defined as <Create;Read;Update;Delete>. Each value is separated by the ";" character. an example of such a quadruple is: "crud_usage=True;True;False;False", meaning: Create = True, Read = True, Update = False and Delete = False
  • ws_uri. URI of the resource describing the Web service
  • 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

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.

Query Answer from the Endpoint

If the query is successfully performed by the endpoint (i.e., the Web service 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 occurred, one of the HTTP status messages with the description of the error message in the body of the HTTP query will be returned.


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-WS-200 Warning No endpoint URL No endpoint URL defined for this query.
WS-AUTH-REGISTRAR-WS-201 Warning No crud usage defined No crud usage defined for this query.
WS-AUTH-REGISTRAR-WS-202 Warning No web service URI defined No web service URI defined for this query.
WS-AUTH-REGISTRAR-WS-203 Fatal Can't check of the web service was already registered to this WSF An error occured when we tried to check if the web service was already registered to this web service network.
WS-AUTH-REGISTRAR-WS-204 Warning Web service already registered This web service is already registered to this Web Service Framework.
WS-AUTH-REGISTRAR-WS-300 Fatal Can't register this web service to the network An error occured when we tried to register this new web service to the network.
WS-AUTH-REGISTRAR-WS-301 Fatal Requested source interface not existing The source interface you requested is not existing for this web service endpoint.
WS-AUTH-REGISTRAR-WS-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-WS-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.

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