sd-webhook-framework/schema.json at master · linaro-its/sd-webhook-framework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Linaro's Service Desk Webhook Framework Configuration Schema",
    "type": "object",
    "properties": {
        "handlers": {
            "description": "Declares which request types map onto which handler",
            "type": "object"
        },
        "cf_cachefile": {
            "description": "Location to use for cache of custom field IDs. Defaults to file stored in the repo",
            "type": "string"
        },
        "cf_use_server_api": {
            "description": "Use Server REST API to retrieve custom fields",
            "type": "boolean"
        },
        "cf_use_cloud_api": {
            "description": "Use Cloud REST API to retrieve custom fields",
            "type": "boolean"
        },
        "vault_iam_role": {
            "description": "AWS IAM role to use when authenticating to Vault",
            "type": "string"
        },
        "vault_server_url": {
            "description": "Where to reach the Vault server",
            "type": "string"
        },
        "bot_name": {
            "description": "Account name to be used for all Service Desk operations",
            "type": "string"
        },
        "bot_password": {
            "description": "Bot's account password",
            "type": "string"
        },
        "vault_bot_name": {
            "description": "Path to retrieving the bot's password from Vault",
            "type": "string"
        },
        "ssm_bot_name": {
            "description": "Path to retrieving the bot's password from AWS SSM",
            "type": "string"
        },
        "ldap_enabled": {
            "description": "Is LDAP integration used?",
            "type": "boolean"
        },
        "ldap_server": {
            "description": "LDAP server URI",
            "type": "string"
        },
        "ldap_base_dn": {
            "description": "Base DN for LDAP server or leave blank if to be determined automatically",
            "type": "string"
        },
        "ldap_default_account_ou": {
            "description": "Where to place new accounts. Base DN will be appended",
            "type": "string"
        },
        "ldap_security_groups": {
            "description": "Where to find security groups. Base DN will be appended",
            "type": "string"
        },
        "ldap_mailing_groups": {
            "description": "Where to find mailing groups. Base DN will be appended",
            "type": "string"
        },
        "ldap_user": {
            "description": "DN of user to be used for LDAP operations",
            "type": "string"
        },
        "ldap_password": {
            "description": "Password for ldap_user",
            "type": "string"
        },
        "vault_ldap_name": {
            "description": "Path to retrieving the LDAP user password from Vault",
            "type": "string"
        },
        "ssm_ldap_name": {
            "description": "Path to retrieving the LDAP user password from AWS SSM",
            "type": "string"
        },
        "mail_host": {
            "description": "Desired email relay host. Only define if sending email from handlers",
            "type": "string"
        },
        "mail_port": {
            "description": "Define if a port other than 25 is needed",
            "type": "integer"
        },
        "mail_ssl": {
            "description": "Define if SSL is required for the email connection",
            "type": "boolean"
        },
        "mail_user": {
            "description": "Sending username. Only define if authentication is required",
            "type": "string"
        },
        "mail_password": {
            "description": "Password for mail user",
            "type": "string"
        },
        "vault_mail_name": {
            "description": "Path to retrieving the mail user's password from Vault",
            "type": "string"
        },
        "final_entry": {
            "description": "Marker to allow previous entries to be commented out safely",
            "type": "string"
        }
    },
    "required": [
        "handlers",
        "cf_use_server_api",
        "cf_use_cloud_api",
        "bot_name",
        "google_enabled",
        "ldap_enabled",
        "final_entry"
    ]
}