AppSuite:OAuth 2 0 Provider Operator Guide: Difference between revisions

From Open-Xchange
No edit summary
No edit summary
Line 4: Line 4:


With OX App Suite v7.8.0 a service provider can decide to publish a certain subset of the OX HTTP API via OAuth 2.0. See the [[AppSuite:OAuth_2_0_Client_Developer_Guide|developer guide]] for an overview of the available APIs. The feature as a whole is contained in separate optional packages and requires some configuration. Supported client applications must be of type <code>confidential</code> according to the <code>web application</code> profile defined in [http://tools.ietf.org/html/rfc6749 RFC 6749]. Every application must be registered at the OX backend. The registration process is up to you, while the backend provides SOAP and RMI interfaces to persist those registrations and generates the client-specific credentials that are needed to gain access for granting users.
With OX App Suite v7.8.0 a service provider can decide to publish a certain subset of the OX HTTP API via OAuth 2.0. See the [[AppSuite:OAuth_2_0_Client_Developer_Guide|developer guide]] for an overview of the available APIs. The feature as a whole is contained in separate optional packages and requires some configuration. Supported client applications must be of type <code>confidential</code> according to the <code>web application</code> profile defined in [http://tools.ietf.org/html/rfc6749 RFC 6749]. Every application must be registered at the OX backend. The registration process is up to you, while the backend provides SOAP and RMI interfaces to persist those registrations and generates the client-specific credentials that are needed to gain access for granting users.
== Installation and Configuration ==
The OAuth provider feature is separated into two packages <code>open-xchange-oauth-provider</code> and <code>open-xchange-admin-oauth-provider</code>. The former one needs to be installed on every groupware node, the latter one provides the client provisioning interfaces and may be installed on your dedicated provisioning nodes. On a Debian setup you would install those packages like so:
<pre>$ apt-get install open-xchange-oauth-provider open-xchange-admin-oauth-provider</pre>

Revision as of 13:20, 4 August 2015

This information is valid from 7.8.0

Open-Xchange OAuth 2.0 Provider Operator Guide

With OX App Suite v7.8.0 a service provider can decide to publish a certain subset of the OX HTTP API via OAuth 2.0. See the developer guide for an overview of the available APIs. The feature as a whole is contained in separate optional packages and requires some configuration. Supported client applications must be of type confidential according to the web application profile defined in RFC 6749. Every application must be registered at the OX backend. The registration process is up to you, while the backend provides SOAP and RMI interfaces to persist those registrations and generates the client-specific credentials that are needed to gain access for granting users.

Installation and Configuration

The OAuth provider feature is separated into two packages open-xchange-oauth-provider and open-xchange-admin-oauth-provider. The former one needs to be installed on every groupware node, the latter one provides the client provisioning interfaces and may be installed on your dedicated provisioning nodes. On a Debian setup you would install those packages like so:

$ apt-get install open-xchange-oauth-provider open-xchange-admin-oauth-provider