Newer
Older
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
{
"description": "This type represents modifications to a threshold. It shall comply with the provisions defined in table 6.5.2.11-1.\n",
"type": "object",
"properties": {
"callbackUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
},
"authentication": {
"type": "object",
"required": [
"authType"
],
"properties": {
"authType": {
"description": "Defines the types of Authentication / Authorization which the API consumer is willing to accept when receiving a notification. Permitted values: * BASIC: In every HTTP request to the notification endpoint, use\n HTTP Basic authentication with the client credentials. \n* OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the\n notification endpoint, use an OAuth 2.0 Bearer token, obtained\n using the client credentials grant type.\n* TLS_CERT: Every HTTP request to the notification endpoint is sent\n over a mutually authenticated TLS session, i.e. not only the\n server is authenticated, but also the client is authenticated\n during the TLS tunnel setup.\n",
"type": "array",
"items": {
"type": "string",
"enum": [
"BASIC",
"OAUTH2_CLIENT_CREDENTIALS",
"TLS_CERT"
]
}
},
"paramsBasic": {
"description": "Parameters for authentication/authorization using BASIC. Shall be present if authType is \"BASIC\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n",
"type": "object",
"properties": {
"userName": {
"description": "Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
"type": "string"
},
"password": {
"description": "Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band.\n",
"type": "string"
}
}
},
"paramsOauth2ClientCredentials": {
"description": "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the contained information has not been provisioned out of band. Shall be absent otherwise.\n",
"type": "object",
"properties": {
"clientId": {
"description": "Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n",
"type": "string"
},
"clientPassword": {
"description": "Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. The clientId and clientPassword passed in a subscription shall not be the same as the clientId and clientPassword that are used to obtain authorization for API requests. Client credentials may differ between subscriptions. The value of clientPassword should be generated by a random process.\n",
"type": "string"
},
"tokenEndpoint": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}
}