Files
=====

.. _GetReadAccessSettingsGroups:

GetReadAccessSettingsGroups
---------------------------

Read access of a group

.. code-block:: json

 enum GetReadAccessSettingsGroups {
  GET_READ_ACCESS_SETTINGS_GROUPS_UNSPECIFIED = 0;
  // return those groups of all objects the user is allowed to see
  GET_READ_ACCESS_SETTINGS_GROUPS_VISIBLE = 1;
  // return only those groups which exist on all objects
  GET_READ_ACCESS_SETTINGS_GROUPS_MATCHING = 2;
  // return all groups of all objects
  GET_READ_ACCESS_SETTINGS_GROUPS_ALL = 3;
 }

+---------------------------------------------+-----+--------------------------------------------------------------+
| Value                                       | Tag | Description                                                  |
+=============================================+=====+==============================================================+
| GET_READ_ACCESS_SETTINGS_GROUPS_UNSPECIFIED | 0   |                                                              |
+---------------------------------------------+-----+--------------------------------------------------------------+
| GET_READ_ACCESS_SETTINGS_GROUPS_VISIBLE     | 1   | Returns the groups of all objects the user is allowed to see |
+---------------------------------------------+-----+--------------------------------------------------------------+
| GET_READ_ACCESS_SETTINGS_GROUPS_MATCHING    | 2   | Returns only groups which exist on all objects               |
+---------------------------------------------+-----+--------------------------------------------------------------+
| GET_READ_ACCESS_SETTINGS_GROUPS_ALL         | 3   | Return all groups of all objects                             |
+---------------------------------------------+-----+--------------------------------------------------------------+

.. _GetReadAccessSettingsGroups:

GetReadAccessSettingsGroups
---------------------------

Read access of a user

.. code-block:: json

 enum GetReadAccessSettingsUsers {
  GET_READ_ACCESS_SETTINGS_USERS_UNSPECIFIED = 0;
  // do not return users at all
  GET_READ_ACCESS_SETTINGS_USERS_NO = 1;
  // return users only for matching groups
  GET_READ_ACCESS_SETTINGS_USERS_MATCHING = 2;
  // return all users of the corresponding groups
  GET_READ_ACCESS_SETTINGS_USERS_ALL = 3;
 }

+--------------------------------------------+-----+----------------------------------------------+
| Value                                      | Tag | Description                                  |
+============================================+=====+==============================================+
| GET_READ_ACCESS_SETTINGS_USERS_UNSPECIFIED | 0   |                                              |
+--------------------------------------------+-----+----------------------------------------------+
| GET_READ_ACCESS_SETTINGS_USERS_NO          | 1   | Do not return users at all                   |
+--------------------------------------------+-----+----------------------------------------------+
| GET_READ_ACCESS_SETTINGS_USERS_MATCHING    | 2   | Return users only for matching groups        |
+--------------------------------------------+-----+----------------------------------------------+
| GET_READ_ACCESS_SETTINGS_USERS_ALL         | 3   | Return all users of the corresponding groups |
+--------------------------------------------+-----+----------------------------------------------+

.. _UsersType:

UsersType
---------

Describes the user status

.. code-block:: json

 enum UsersType {
  USERS_TYPE_UNSPECIFIED = 0;
  // means active and confirmed and invited and not access restricted
  USERS_TYPE_NORMAL = 1;
  USERS_TYPE_INACTIVE = 2;
  USERS_TYPE_UNCONFIRMED = 4;
  USERS_TYPE_NOTINVITED = 8;
  USERS_TYPE_ACCESSRESTRICTED = 16;
 }

+-----------------------------+-----+------------------------------------------------------------------------------------+
| Value                       | Tag | Description                                                                        |
+=============================+=====+====================================================================================+
| USERS_TYPE_UNSPECIFIED      | 0   |                                                                                    |
+-----------------------------+-----+------------------------------------------------------------------------------------+
| USERS_TYPE_NORMAL           | 1   | ``Normal`` users mean active, confirmed, invited, and not access restricted users. |
+-----------------------------+-----+------------------------------------------------------------------------------------+
| USERS_TYPE_INACTIVE         | 2   |                                                                                    |
+-----------------------------+-----+------------------------------------------------------------------------------------+
| USERS_TYPE_UNCONFIRMED      | 4   |                                                                                    |
+-----------------------------+-----+------------------------------------------------------------------------------------+
| USERS_TYPE_NOTINVITED       | 8   |                                                                                    |
+-----------------------------+-----+------------------------------------------------------------------------------------+
| USERS_TYPE_ACCESSRESTRICTED | 16  |                                                                                    |
+-----------------------------+-----+------------------------------------------------------------------------------------+