Commit 5417d535 authored by ubedv's avatar ubedv

Update README.md

parent c5a7fd46
......@@ -7,10 +7,14 @@ of an arbitrary service.
They use the JSON encoding for input and output. The specific formats are outlined below.
Input format
Input Format
-
```
{
// The state which is to be reached by this script execution
//
// deployed -> the script is supposed to deploy the user
// not_deployed -> the script is supposed to remove the user
"state_target": "deployed" or "not_deployed",
......@@ -34,13 +38,20 @@ Input format
"question_name": "user answer to this question"
}
}
```
Output format
Output Format
-
```
{
// The state as of now (after the script run)
//
// deployed -> The deployment was processed successfully
// not_deployed -> The removal of the user was processed successfully
// failed -> An error occured and the script could not reach the 'state_target' from the Input
// rejected -> The user is not permitted to use this service, for whatever reason
// questionnaire-> The script needs more information to deploy the user
"state": "deployed" or "not_deployed" or "failed" or "rejected" or "questionnaire",
......@@ -53,9 +64,10 @@ Output format
"question_name": "question"
},
// additional credentials and instructions, the user needs to access the service
// additional credentials and instructions, the user needs to access the service (in addition to her credentials from the Input)
// an example would be the user name of the provisioned user.
"credentials": {
"key": "value"
}
}
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment