Skip to main content

Config for openelis

Jobs that use the openelis adaptor may require authentication. A "credential" for the openelis adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
"password": "@some(!)Str0ngp4ss0w0rd",
"username": "admin",
"baseUrl": "https://demo.openelis-global.org"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"baseUrl": {
"title": "Base URL",
"description": "The base URL for the OpenELIS instance",
"format": "uri",
"minLength": 1,
"examples": [
"https://demo.openelis-global.org"
]
},
"username": {
"title": "Username",
"type": "string",
"description": "Username",
"examples": [
"admin"
]
},
"password": {
"title": "Password",
"type": "string",
"description": "Password",
"writeOnly": true,
"examples": [
"@some(!)Str0ngp4ss0w0rd"
]
}
},
"type": "object",
"additionalProperties": true,
"required": [
"password",
"username",
"baseUrl"
]
}