Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Commit d080687

Browse files
authored
Add private endpoint usage with IAM to docs (#475)
1 parent 14646b7 commit d080687

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/getting_started.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ You can easily connect to your Cloudant account using an IAM API key:
111111
# Authenticate using an IAM API key
112112
client = Cloudant.iam(ACCOUNT_NAME, API_KEY, connect=True)
113113
114+
If you need to authenticate to a server outside of the `cloudant.com` domain, you can use the `url` parameter:
115+
116+
.. code-block:: python
117+
118+
# Authenticate using an IAM API key to an account outside of the cloudant.com domain
119+
client = Cloudant.iam(None, API_KEY, url='https://private.endpoint.example', connect=True)
120+
114121
115122
****************
116123
Resource sharing

0 commit comments

Comments
 (0)