Contract No.: 285248 Strategic Objective
Identity Management Generic Enabler API Specification
Download 1.78 Mb.
|
- Navigate this page:
- 12.1.2Intended Audience
- 12.1.3API Change History
- 12.1.4How to Read this Document
- 12.1.5Additional Resources
- 12.2General Identity Management Generic Enabler API Information
- 12.2.2Authentication At service side one of the herein specified authentication protocols (SAML, OAuth, OpenID) must be implemented. 12.2.3Representation Format
- 12.2.4Representation Transport
- 12.2.5Resource Identification
12Identity Management Generic Enabler API Specification12.1Introduction to the Identity Management GE (IdM GE) APIPlease check the FI-WARE Open Specifications Legal Notice to understand the rights to use FI-WARE Open Specifications. 12.1.1IdM GE API CoreIdM GE API specifications comply with existing standards for authentication and user and provile access information. The following sections provide pointers to those standards and elaborate which parts of them are considered mandatory vs optional and, when applicable, details about how the RESTful binding work. 12.1.2Intended AudienceThis specification is intended for Service Consumers (with development skills) and Cloud Providers. For the former, this document provides a full specification of how to interoperate with the Identity Management Service API. For the latter, this specification indicates the interface to be provided to the client application developers to provide the described functionalities. To use this information, the reader should first have a general understanding of the Generic Enabler service (FIWARE.ArchitectureDescription.Identity_Management_Generic_Enabler) The API user should be familiar with:
12.1.3API Change HistoryCurrent version is: Version 2.0.0, 2013.10.18. The most recent changes are described in the table below:
12.1.4How to Read this DocumentThe following list summarizes special notations for the current and future versions of this document.
12.1.5Additional ResourcesDetailed specification and descriptions can be found here:
A detailed description of what parts of the used standards is considered as optional or mandatory is described in the Open Specification. 12.2General Identity Management Generic Enabler API Information12.2.1Resources SummaryAlthough the access URLs for all these GEs are distinct for every instance, they follow some scheme. This is as follows:
12.2.2AuthenticationAt service side one of the herein specified authentication protocols (SAML, OAuth, OpenID) must be implemented. 12.2.3Representation FormatIn case of SAML always XML is used, whereas for OAuth no body is defined. In case of the OpenID Authentication the attributs are formatted as JSON string. 12.2.4Representation TransportResource representation is transmitted between client and server by using HTTP 1.1 protocol, as defined by IETF RFC-2616. Each time an HTTP request contains payload, a Content-Type header shall be used to specify the MIME type of wrapped representation. In addition, both client and server may use as many HTTP headers as they consider necessary. 12.2.5Resource IdentificationThe resources are uniquely identified by their URI. 12.2.6LimitsResources are only limited by hardware resources. 12.2.7ExtensionsThe SAML protocol supports extensions, however this is not supported at the moment. Maybe this will be considered in the future.
12.2.8FaultsSynchronous Faults
SAML always returns a SAML response containing the field "Status" defined in the SAML specification: In case of an error, the status code will be "Error" instead of "Success" and a detailed error message may be contained within the status block.
Download 1.78 Mb. Share with your friends:
|