From cb92fbaa6a5104dee99b54d033ad8772c9dce609 Mon Sep 17 00:00:00 2001 From: Kshithij Iyer Date: Thu, 3 Oct 2019 09:25:59 +0530 Subject: [PATCH] Restructing README.md file --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5fb0448..28ac4a9 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ A user can currently make use of following supported features: api_key based authentication for user operations creating users
+``` endpoint:
/users
methodtype: POST
@@ -39,8 +40,9 @@ response:
email=email,
status="username created successfully"
}
- +``` Login
+``` endpoint:
/login
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.
@@ -49,14 +51,16 @@ Response:
"api_key":"api_key value"
}
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. - +``` Reset api key
+``` methodType: POST
endpoint:
/api/v1.0/users/username/reset
Response: {api_key= value, message = "reset successfully"}
- +``` listing users
+``` One user:
(Admin user only)
endpoint:
@@ -68,8 +72,9 @@ username=username,
api_key=api_key,
admin=boolean indicating created as admin user or not
}
- +``` All users:
+``` (Admin user only)
endpoint:
/users
@@ -79,15 +84,17 @@ response:
[user1: {username: username, password: password(hashed), api_key:api_key} ]
status=200 OK
}
- +``` Promote users to admin status
+``` (Admin user only)
endpoint:
methodType: PUT
/api/v1.0/users/username/promote
Response: {user has been promoted as an admin}
- +``` Update user fields
+``` endpoint:
methodType: PUT
/api/v1.0/users/username
@@ -104,7 +111,9 @@ password= hashed_password,
email=email,
status=OK
}

+``` Upload/create credentials
+``` POST /users/username/credentials
RequestBody:
{ file : text or attached file
@@ -117,8 +126,10 @@ return : response with successful credential upload status
List credentials
GET /users/username/credentials/file_name
return : response with encrypted credentials from file
+``` Delete credentials
+``` DELETE /users/username/credentials/file-name
return : response with successful delete status

@@ -130,6 +141,8 @@ vault_pass: ansible vault password
}
return : response with successful credential update status

+``` + ## 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.