Skip to content
This repository has been archived by the owner on Sep 23, 2024. It is now read-only.

Restructing README.md file #53

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ A user can currently make use of following supported features:
api_key based authentication for user operations

<b> creating users </b> <br>
```
endpoint:<br>
/users <br>
methodtype: POST <br>
Expand All @@ -39,8 +40,9 @@ response: <br>
email=email,<br>
status="username created successfully" <br>
}<br>

```
<b> Login </b> <br>
```
endpoint:<br>
/login <br>
User has to send a basic authentication header with username and password generated above, an autogenerated (hashed) api_key will be returned to the user for resource access.<br>
Expand All @@ -49,14 +51,16 @@ Response:<br>
"api_key":"api_key value"<br>
}<br>
This api_key will be verified by passing a key:api_key and value: api_key value obtained above,in the request headers during each of the API calls including user and workspace actions to grant resource access by determining the access rights of the current user. Admin users can access all resources whereas other resources are only accessible to the owner of that resource.

```
<b> Reset api key </b> <br>
```
methodType: POST <br>
endpoint: <br>
/api/v1.0/users/username/reset <br>
Response: {api_key= value, message = "reset successfully"}<br>

```
<b>listing users</b> <br>
```
<b>One user: </b><br>
(Admin user only) <br>
endpoint:<br>
Expand All @@ -68,8 +72,9 @@ username=username,<br>
api_key=api_key,<br>
admin=boolean indicating created as admin user or not<br>
}<br>

```
<b>All users:</b><br>
```
(Admin user only)<br>
endpoint:<br>
/users<br>
Expand All @@ -79,15 +84,17 @@ response:<br>
[user1: {username: username, password: password(hashed), api_key:api_key} ] <br>
status=200 OK<br>
}<br>

```
<b>Promote users to admin status</b><br>
```
(Admin user only)<br>
endpoint:<br>
methodType: PUT<br>
/api/v1.0/users/username/promote<br>
Response: {user has been promoted as an admin}<br>

```
<b>Update user fields</b><br>
```
endpoint:<br>
methodType: PUT<br>
/api/v1.0/users/username<br>
Expand All @@ -104,7 +111,9 @@ password= hashed_password,<br>
email=email,<br>
status=OK<br>
}<br><br>
```
<b>Upload/create credentials</b><br>
```
POST /users/username/credentials<br>
RequestBody:<br>
{ file : text or attached file<br>
Expand All @@ -117,8 +126,10 @@ return : response with successful credential upload status<br>
<b>List credentials</b><br>
GET /users/username/credentials/file_name<br>
return : response with encrypted credentials from file<br>
```

<b>Delete credentials</b><br>
```
DELETE /users/username/credentials/file-name<br>
return : response with successful delete status<br>
<br>
Expand All @@ -130,6 +141,8 @@ vault_pass: ansible vault password<br>
}<br>
return : response with successful credential update status<br>
<br>
```

## Linchpin Project
LinchPin is a simple cloud orchestration tool. Its intended purpose is managing cloud resources across multiple infrastructures. These resources can be provisioned, decommissioned, and configured all using declarative data and a simple command-line interface.

Expand Down