Skip to content

Commit c691df9

Browse files
Update README.md
1 parent a82c32b commit c691df9

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,81 @@
1+
<a href="https://www.cortex-ia.co.uk/" target="_blank"><img src="https://github.com/CortexIATest/CTXImages/blob/master/Cortex-350-120.png" alt="Welcome to Cortex!" width="350" height="120" border="0"></a>
2+
13
# CTX-User-Access-Management
24
The User Access Management module should be used as the single authority to manage authentication and authorisation within a system. This module contains the Cortex flows and subtasks to perform authentication and authorisation.
5+
6+
The module allows users to perform the following functionality:
7+
* Authenticate a user
8+
* End user session
9+
* Manage active sessions
10+
* Create user session
11+
* Check authorisation token
12+
13+
## Table of Contents
14+
1) [Dependencies](#dependencies)
15+
* [Cortex Version](#cortex-version)
16+
* [OCIs](#ocis)
17+
* [Files](#files)
18+
* [Other](#other)
19+
1) [Installation](#installation)
20+
1) [How to use](#how-to-use)
21+
1) [How you can contribute](#how-you-can-contribute)
22+
1) [Versioning](#versioning)
23+
1) [Licensing](#licensing)
24+
25+
## Dependencies
26+
### Cortex Version
27+
This version of the CTX-User-Access-Management module was developed in Cortex v6.4.0. Some functionality may not be available in earlier versions of Cortex.
28+
29+
### OCIs
30+
The CTX-User-Access-Management module requires the following Cortex OCIs:
31+
* Cortex Database OCI
32+
* If to be used with Active Directory integration:
33+
* Cortex Active Directory OCI
34+
* If to be used with Cortex Vista security integration:
35+
* Cortex PowerShell OCI
36+
* [CTX-Vista-User-Management module](https://github.com/CortexIntelligentAutomation/CTX-Vista-User-Management)
37+
38+
39+
### Files
40+
The CTX-User-Access-Management module requires the following files:
41+
* [CTX-User-Access-Management Studio Package](https://github.com/CortexIntelligentAutomation/CTX-User-Access-Management/releases/download/v1.0/CTX-User-Access-Management.studiopkg)
42+
43+
### Other Requisites
44+
The CTX-User-Access-Management module has no additional requirements.
45+
46+
## Installation
47+
Details of how the module should be imported into Cortex can be found in the [Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-User-Access-Management/blob/master/CTX-User-Access-Management%20-%20Deployment%20Plan.pdf).
48+
49+
## How to use
50+
A detailed User Guide has been provided with instructions on how to use the module, available [here](https://github.com/CortexIntelligentAutomation/CTX-User-Access-Management/blob/master/CTX-User-Access-Management%20-%20User%20Guide.pdf ). Configuration of each flow/subtask's inputs and outputs are detailed in notes on the flow/subtask workspace.
51+
52+
## How you can contribute
53+
Unfortunately, we cannot offer pull requests at this time or accept any improvements.
54+
55+
## Versioning
56+
The CTX-User-Access-Management module has the following versions, starting with the most recent:
57+
58+
Version | Release | Functionality | Notes
59+
------------ | ------------- | ----------- | -----------
60+
v1.0 | 04/01/2019 | UAM-Authenticate-User | Created
61+
v1.0 | 04/01/2019 | UAM-End-User-Session | Created
62+
v1.0 | 04/01/2019 | UAM-SessionManagement | Created
63+
v1.0 | 04/01/2019 | UAM-Create-User-Session | Created
64+
v1.0 | 04/01/2019 | UAM-Check-Authorisation-Token | Created
65+
66+
## Licensing
67+
All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
68+
69+
Copyright 2018 Cortex Limited
70+
71+
Licensed under the Apache License, Version 2.0 (the "License");
72+
you may not use this file except in compliance with the License.
73+
You may obtain a copy of the License at
74+
75+
http://www.apache.org/licenses/LICENSE-2.0
76+
77+
Unless required by applicable law or agreed to in writing, software
78+
distributed under the License is distributed on an "AS IS" BASIS,
79+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
80+
See the License for the specific language governing permissions and
81+
limitations under the License.

0 commit comments

Comments
 (0)