Skip to content

Commit 03ea523

Browse files
committed
Refactor configuration settings structure and authentication methods
1 parent 3c5798a commit 03ea523

File tree

1 file changed

+31
-18
lines changed

1 file changed

+31
-18
lines changed

README.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -87,28 +87,41 @@ Example configuration file (clientconfig.json):
8787

8888
```json
8989
{
90-
"Auth": {
91-
"ClientID": "client-id",
92-
"ClientSecret": "client-secret",
93-
"Username": "username",
94-
"Password": "password"
90+
"Auth": {
91+
"ClientID": "client-id", // set this for oauth2 based authentication
92+
"ClientSecret": "client-secret", // set this for oauth2 based authentication
93+
"Username": "username", // set this for basic auth
94+
"Password": "password" // set this for basic auth
9595
},
9696
"Environment": {
97-
"InstanceName": "yourinstance",
98-
"OverrideBaseDomain": "",
99-
"APIType": "" // "jamfpro" / "msgraph"
97+
"APIType": "", // define the api integration e.g "jamfpro" / "msgraph"
98+
"InstanceName": "yourinstance", // used for "jamfpro"
99+
"OverrideBaseDomain": "", // used for "jamfpro"
100+
"TenantID": "tenant-id", // used for "msgraph"h
101+
"TenantName ": "resource", // used for "msgraph"
100102
},
101103
"ClientOptions": {
102-
"LogLevel": "LogLevelDebug", // "LogLevelDebug" / "LogLevelInfo" / "LogLevelWarn" / "LogLevelError" / "LogLevelFatal" / "LogLevelPanic"
103-
"LogOutputFormat": "console", // "console" / "json"
104-
"LogConsoleSeparator": " ", // " " / "\t" / "," / etc.
105-
"LogExportPath": "/path/to/export/your/logs",
106-
"HideSensitiveData": true, // redacts sensitive data from logs
107-
"MaxRetryAttempts": 5, // set number of retry attempts
108-
"MaxConcurrentRequests": 3, // set number of concurrent requests
109-
"EnableCookieJar": false, // enable cookie jar support
110-
"FollowRedirects": true, // follow redirects
111-
"MaxRedirects": 5 // set number of redirects to follow
104+
"Logging": {
105+
"LogLevel": "LogLevelDebug", // "LogLevelDebug" / "LogLevelInfo" / "LogLevelWarn" / "LogLevelError" / "LogLevelFatal" / "LogLevelPanic"
106+
"LogOutputFormat": "console", // "console" / "json"
107+
"LogConsoleSeparator": " ", // " " / "\t" / "," / etc.
108+
"LogExportPath": "/your/log/path/folder",
109+
"HideSensitiveData": true // redacts sensitive data from logs
110+
},
111+
"Cookie": {
112+
"EnableCookieJar": true // enable cookie jar support
113+
},
114+
"Retry": {
115+
"MaxRetryAttempts": 5, // set number of retry attempts
116+
"EnableDynamicRateLimiting": true // enable dynamic rate limiting
117+
},
118+
"Concurrency": {
119+
"MaxConcurrentRequests": 3 // set number of concurrent requests
120+
},
121+
"Redirect": {
122+
"FollowRedirects": true, // follow redirects
123+
"MaxRedirects": 5 // set number of redirects to follow
124+
}
112125
}
113126
}
114127
```

0 commit comments

Comments
 (0)