Skip to content

Commit

Permalink
add how to use section
Browse files Browse the repository at this point in the history
  • Loading branch information
RuslanPopenko committed Jun 29, 2016
1 parent 2e77ea5 commit a110e2e
Show file tree
Hide file tree
Showing 5 changed files with 162 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/basic_concepts/security_part.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Security part
=============

iVIS use `OAuth 2.0 <https://tools.ietf.org/html/draft-ietf-oauth-v2-31>`_ protocol
iVIS use `OAuth 2.0 <https://tools.ietf.org/html/rfc6749>`_ protocol
(`Spring Security <http://projects.spring.io/spring-security/>`_ provider)

The provider role in OAuth 2.0 is actually split between Authorization Service and Resource Service,
Expand Down
7 changes: 7 additions & 0 deletions docs/how_to_use/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
How to use
==========

.. toctree::
:titlesonly:

ivis_server
153 changes: 153 additions & 0 deletions docs/how_to_use/ivis_server.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
iVIS server
===========

iVIS server requires to manage clients, users, schools, pupils of iVIS system.

Explanation for not understandable parts.

* `Create/Edit iVIS client`_

.. _`Create/Edit iVIS client`:

Create/Edit iVIS client
-----------------------

Clients require you get access to system data.

Page for this purpose is

.. image:: /images/ivisClient.png

Name
~~~~

The name of client.

Resources
~~~~~~~~~

The name of resource which client obtain.

Owner
~~~~~

The name of User which has got client.

Secret
~~~~~~

The password of client for access to resources

Scope
~~~~~

Scope for client activity.

There are 3 parameters for scope:

.. envvar:: read

Requires only read data of resources (GET requests)

.. envvar:: write

Requires change data of resources (POST, PUT, DELETE)

.. note::
If you want create client based on API, you will be enough read and write

.. envvar:: execute

Requires change data of resources through proxy. This client needs ivis-core and ivis-sdk dependencies.

Authorized Grant Types
~~~~~~~~~~~~~~~~~~~~~~

This section allows choose ways for obtain access token for client

.. envvar:: authorization_code

About this you can read at `Authorization Code Grant <https://tools.ietf.org/html/rfc6749#section-4.1>`_

.. envvar:: implicit

About this you can read at `Implicit Grant <https://tools.ietf.org/html/rfc6749#section-4.2>`_

.. envvar:: refresh_token

About this you can read at `Refreshing an Access Token <https://tools.ietf.org/html/rfc6749#section-6>`_

.. envvar:: client_credentials

About this you can read at `Client Credentials Grant <https://tools.ietf.org/html/rfc6749#section-4.4>`_

.. envvar:: password

About this you can read at `Resource Owner Password Credentials Grant <https://tools.ietf.org/html/rfc6749#section-4.3>`_

Registered Redirect Uri
~~~~~~~~~~~~~~~~~~~~~~~

URL for access token or authorization code response.

Roles
~~~~~

.. envvar:: ROLE_ADMIN

Can edit/view information

.. envvar:: ROLE_USER

Can only view information

Access Token Validity(sec)
~~~~~~~~~~~~~~~~~~~~~~~~~~

Number of seconds after which the access token expires, and is no longer valid.

Refresh Token Validity(sec)
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Number of seconds after which the refresh token expires, and is no longer valid.

.. note::

Recommendation: refresh token validity must be longer than access.

.. seealso::

Read about `Access Token <https://tools.ietf.org/html/rfc6749#section-1.4>`_ and
`Refresh Token <https://tools.ietf.org/html/rfc6749#section-1.5>`_
































Binary file added docs/images/ivisClient.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ Contents
basic_concepts/index
quick_start/index
api/index
how_to_use/index

.. include:: /common/contribute.txt

0 comments on commit a110e2e

Please sign in to comment.