Commit 8b454932 authored by Marcus's avatar Marcus
Browse files

add conventions for keys in the return dict

parent 66f0e847
......@@ -64,7 +64,7 @@ Output Format
//
// 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
// failed -> An error occurred 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",
......@@ -90,13 +90,23 @@ Output Format
"age_question": 18, // age_question must be an integer, defaulting to 18
"list_question": ["person_a", "person_b"], // list_question must be one of the listed options
"list_question_2": [1, 2], // list_question_2 must be one of the listed options
"are_you_sure": false // are_you_sure must be a boolean, with false being the default value
"are_you_sure": false // are_you_sure must be a boolean, with false being the default value
},
// 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"
}
// additional credentials and instructions, the user needs to access the service
// (in addition to the credentials from the Input).
// An example would be the user name of the provisioned user.
// "credentials": {
// "key": "value"
// }
// By convention we currently recommend returning these keys for interoperability with other services:
"ssh_user" // the username for the user
"ssh_host" // the hostname where to ssh
// Furthermore additional information MAY be provided. Examples:
"privacy_policy_url" // the URL for the privacy policy of the service
"service_[admin|tech|support|cert|other]_contact" // email address
}
```
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