From 075ddbc08849a294df578527b0654f122d5088de Mon Sep 17 00:00:00 2001 From: Andrew Martinez Date: Thu, 3 Aug 2023 12:12:02 -0400 Subject: [PATCH] outline auth and config types --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index bbb2c124..5d768546 100644 --- a/README.md +++ b/README.md @@ -306,7 +306,18 @@ panic(err) credentials := edge_apis.NewUpdbCredentials("Joe Admin", "20984hgn2q048ngq20-3gn") credentials.CaPool = caPool +//Note: the CA pool can be provided here or during the Authenticate() call. It is allowed here to enable +// calls to REST API endpoints that do not require authentication. managementClient := edge_apis.NewManagementApiClient(apiUrl, credentials.GetCaPool()), + +//"configTypes" are string identifiers of configuration that can be requested by clients. Developers may +//specify their own in order to provide distributed identity and/or service specific configurations. The +//OpenZiti tunnelers use this capability to configure interception of network connections. +//See: https://openziti.io/docs/learn/core-concepts/config-store/overview +//Example: configTypes = []string{"myCustomAppConfigType"} +var configTypes []string + +managementClient.Authenticate(credentials, configTypes) ``` ### Example: Requesting Management Services