Documented login/logout endpoint
diff --git a/apiary.apib b/apiary.apib
index d7034d8..fe1b221 100644
--- a/apiary.apib
+++ b/apiary.apib
@@ -3,64 +3,6 @@
# XOS
-# Group Example
-
-## Example Services Collection [/api/service/exampleservice/]
-
-### List all Example Services [GET]
-
-+ Response 200 (application/json)
-
- [
- {
- "humanReadableName": "MyExample",
- "id": 1,
- "service_message": "This is the test message"
- }
- ]
-
-
-# Group ONOS Services
-
-List of the active onos services
-
-## ONOS Services Collection [/api/service/onos/]
-
-### List all ONOS Services [GET]
-
-+ Response 200 (application/json)
-
- [
- {
- "humanReadableName": "service_ONOS_vBNG",
- "id": 5,
- "rest_hostname": "",
- "rest_port": "8181",
- "no_container": false,
- "node_key": ""
- }
- ]
-
-
-# Group vSG
-
-## vSG Collection [/api/service/vsg/]
-
-### List all vSGs [GET]
-
-+ Response 200 (application/json)
-
- [
- {
- "humanReadableName": "service_vsg",
- "id": 2,
- "dns_servers": "8.8.8.8",
- "url_filter_kind": null,
- "node_label": null
- }
- ]
-
-
# Group Deployments
List of the XOS deployments
@@ -381,6 +323,129 @@
+# Group Example
+
+## Example Services Collection [/api/service/exampleservice/]
+
+### List all Example Services [GET]
+
++ Response 200 (application/json)
+
+ [
+ {
+ "humanReadableName": "MyExample",
+ "id": 1,
+ "service_message": "This is the test message"
+ }
+ ]
+
+
+# Group ONOS Services
+
+List of the active onos services
+
+## ONOS Services Collection [/api/service/onos/]
+
+### List all ONOS Services [GET]
+
++ Response 200 (application/json)
+
+ [
+ {
+ "humanReadableName": "service_ONOS_vBNG",
+ "id": 5,
+ "rest_hostname": "",
+ "rest_port": "8181",
+ "no_container": false,
+ "node_key": ""
+ }
+ ]
+
+
+# Group vSG
+
+## vSG Collection [/api/service/vsg/]
+
+### List all vSGs [GET]
+
++ Response 200 (application/json)
+
+ [
+ {
+ "humanReadableName": "service_vsg",
+ "id": 2,
+ "dns_servers": "8.8.8.8",
+ "url_filter_kind": null,
+ "node_label": null
+ }
+ ]
+
+
+# Group Utility
+
+List of the XOS Utility API
+
+## Login [/api/utility/login/]
+
+### Log a user in the system [POST]
+
++ Request (application/json)
+
+ {
+ "username": "padmin@vicci.org",
+ "password": "letmein"
+ }
+
++ Response 200 (application/json)
+
+ {
+ "xoscsrftoken":"xuvsRC1jkXAsnrdRlgJvcXpmtthTAqqf",
+ "xossessionid":"7ds5a3wzjlgbjqo4odkd25qsm0j2s6zg",
+ "user": {
+ "policed": null,
+ "site": 1,
+ "is_appuser": false,
+ "is_staff": true,
+ "backend_status": "Provisioning in progress",
+ "id": 1,
+ "is_registering": false,
+ "last_login": "2016-04-29T20:35:58.979122+00:00",
+ "email": "padmin@vicci.org",
+ "no_sync": false,
+ "username": "padmin@vicci.org",
+ "dashboards": [
+ 4,
+ 3,
+ 5
+ ],
+ "login_page": null,
+ "firstname": "XOS",
+ "user_url": null,
+ "deleted": false,
+ "lastname": "admin",
+ "is_active": true,
+ "lazy_blocked": false,
+ "phone": null,
+ "is_admin": true,
+ "enacted": null,
+ "public_key": null,
+ "is_readonly": false,
+ "no_policy": false,
+ "write_protect": false
+ }
+ }
+
+## Logout [/api/utility/logout/]
+
+### Log a user out of the system [POST]
+
++ Request (application/json)
+ {xossessionid: "sessionId"}
+
++ Response 200 (application/json)
+
+
+
# Group Subscribers
Resource related to the CORD Subscribers.
diff --git a/views/ngXosViews/sampleView/src/js/main.js b/views/ngXosViews/sampleView/src/js/main.js
index b22e0ab..b07768a 100644
--- a/views/ngXosViews/sampleView/src/js/main.js
+++ b/views/ngXosViews/sampleView/src/js/main.js
@@ -29,14 +29,6 @@
resource: 'Users'
};
- // retrieving user list
- Users.query().$promise
- .then((users) => {
- this.users = users;
- })
- .catch((e) => {
- throw new Error(e);
- });
}
};
});
\ No newline at end of file
diff --git a/xos/tests/api/source/utility/utility.md b/xos/tests/api/source/utility/utility.md
new file mode 100644
index 0000000..4f6efd0
--- /dev/null
+++ b/xos/tests/api/source/utility/utility.md
@@ -0,0 +1,62 @@
+# Group Utility
+
+List of the XOS Utility API
+
+## Login [/api/utility/login/]
+
+### Log a user in the system [POST]
+
++ Request (application/json)
+
+ {
+ "username": "padmin@vicci.org",
+ "password": "letmein"
+ }
+
++ Response 200 (application/json)
+
+ {
+ "xoscsrftoken":"xuvsRC1jkXAsnrdRlgJvcXpmtthTAqqf",
+ "xossessionid":"7ds5a3wzjlgbjqo4odkd25qsm0j2s6zg",
+ "user": {
+ "policed": null,
+ "site": 1,
+ "is_appuser": false,
+ "is_staff": true,
+ "backend_status": "Provisioning in progress",
+ "id": 1,
+ "is_registering": false,
+ "last_login": "2016-04-29T20:35:58.979122+00:00",
+ "email": "padmin@vicci.org",
+ "no_sync": false,
+ "username": "padmin@vicci.org",
+ "dashboards": [
+ 4,
+ 3,
+ 5
+ ],
+ "login_page": null,
+ "firstname": "XOS",
+ "user_url": null,
+ "deleted": false,
+ "lastname": "admin",
+ "is_active": true,
+ "lazy_blocked": false,
+ "phone": null,
+ "is_admin": true,
+ "enacted": null,
+ "public_key": null,
+ "is_readonly": false,
+ "no_policy": false,
+ "write_protect": false
+ }
+ }
+
+## Logout [/api/utility/logout/]
+
+### Log a user out of the system [POST]
+
++ Request (application/json)
+ {xossessionid: "sessionId"}
+
++ Response 200 (application/json)