57.0.1

Author: PureCloud Jenkins

README.md

@@ -26,20 +26,54 @@ import PureCloudPlatformClientV2
 
 ### Authenticating
 
-The Python SDK does not currently contain helper methods to complete an OAuth flow. The consuming applicaiton must complete an OAuth flow to get an access token outside the scope of the SDK. Once an access token is obtained, it should be set on the SDK via `PureCloudPlatformClientV2.configuration.access_token`. For more information about authenticating with OAuth, see the Developer Center article [Authorization](https://developer.mypurecloud.com/api/rest/authorization/index.html).
+#### Client Credentials Grant
+
+**Use when...**
+
+* The app is authenticating as a non-human (e.g. a service, scheduled task, or other non-UI application)
+
+For headless and non-user applications, the [Client Credentials Grant](http://developer.mypurecloud.com/api/rest/authorization/use-client-credentials.html) 
 
 ```{"language":"python"}
-PureCloudPlatformClientV2.configuration.access_token = 'cuQbSAf1LU4CuIaSj1D6Gm399jmTr7zLTTc3KPSyCvEyJQIo9r648h3SH8oFzLPPKxE3Mvb166lq5NcjSBoGE5A'
+apiclient = PureCloudPlatformClientV2.api_client.ApiClient().get_client_credentials_token("7de3af06-c0b3-4f9b-af45-72f4a14037cc", "qLh-825gtjPrIY2kcWKAkmlaSgi6Z1Ws2BAyixWbTrs")
+authApi = PureCloudPlatformClientV2.AuthorizationApi(apiclient)
+print authApi.get_authorization_permissions()
 ```
 
+#### OAuth2 SAML2 Bearer Grant
+
+**Use when...**
+
+* The app is authenticating as a human user, the [OAuth2 SAML2 Bearer](https://developer.mypurecloud.com/api/rest/authorization/use-saml2-bearer.html)
+
+```{"language":"python"}
+apiclient = PureCloudPlatformClientV2.api_client.ApiClient().get_saml2bearer_token("565c3091-4107-4675-b606-b1fead2d15a4", "9pal483eSr_vCZf0qQomFK298I8htjBZo49FI_lLZQ8", orgName ,encodedsamlassertion)
+usersApi = PureCloudPlatformClientV2.UsersApi(apiclient)
+print usersApi.get_users_me()
+
+```
+
+
+
 ### Setting the Environment
 
 If connecting to a PureCloud environment other than mypurecloud.com (e.g. mypurecloud.ie), set the new base path before constructing any API classes. The new base path should be the base path to the Platform API for your environment.
 
 ```{"language":"python"}
-PureCloudPlatformClientV2.configuration.host = 'https://api.mypurecloud.ie'
+region = PureCloudRegionHosts.us_east_1
+PureCloudPlatformClientV2.configuration.host = region.get_api_host
 ```
 
+### Connect to a Proxy Server
+
+If connecting to a proxy server, set the the address of your proxy server as follows:
+
+```{"language":"python"}
+PureCloudPlatformClientV2.configuration.proxy = 'YOUR_PROXY_URL'
+```
+
+The Python SDK uses `urllib3.ProxyManager` to make requests when `proxy` is given.
+
 ### Making Requests
 
 There are two steps to making requests:

build/PureCloudPlatformClientV2/__init__.py

@@ -32,6 +32,9 @@
 import random
 import tempfile
 import threading
+import base64
+import json
+
 
 from datetime import datetime
 from datetime import date
@@ -87,6 +90,74 @@ def __init__(self, host=None, header_name=None, header_value=None, cookie=None):
         self.access_token = ""
 
 
+
+    def get_client_credentials_token(self, client_id, client_secret):
+        """
+        :param client_id: Client ID to authenticate with
+        :param client_secret: Client Secret to Authenticate with
+        :return: Returns the Api Object which allows this to directly enter into an api call, also sets the token
+        """
+        query_params = {}
+        body = None
+        host = (self.host).split('.', 2)[1]
+        url = 'https://login.' + host + '.com/oauth/token'
+
+        post_params = {'grant_type': 'client_credentials'}
+
+        auth_string = 'Basic ' + base64.b64encode(bytes((client_id + ':' + client_secret).encode('ascii'))).decode(
+            'ascii')
+
+        header_params = {
+            "Authorization": auth_string,
+            'Content-Type': 'application/x-www-form-urlencoded'
+        }
+        header_params = self.sanitize_for_serialization(header_params)
+        post_params = self.sanitize_for_serialization(post_params)
+
+        response = self.request("POST", url,
+                                query_params=query_params,
+                                headers=header_params,
+                                post_params=post_params, body=body);
+        data = json.loads('[' + response.data + ']')
+        self.access_token = data[0]["access_token"]
+        return self;
+
+    def get_saml2bearer_token(self,client_id,client_secret,org_name,assertion):
+        """:param client_id: Client Id to authenticate with
+         :param client_secret: Client Secret to authenticate with
+         :param org_name: Orginization name to authenticate with
+         :param assertion: SamlAssertion encoded
+         :return:
+         """
+
+        query_params = {}
+        body = None
+        host = (self.host).split('.', 2)[1]
+        url = 'https://login.' + host + '.com/oauth/token'
+
+        post_params = {'grant_type': 'urn:ietf:params:oauth:grant-type:saml2-bearer',
+                       'orgName': org_name,
+                       'assertion': assertion
+                       }
+
+        auth_string = 'Basic ' + base64.b64encode(bytes((client_id + ':' + client_secret).encode('ascii'))).decode(
+            'ascii')
+
+        header_params = {
+            "Authorization": auth_string,
+            'Content-Type': 'application/x-www-form-urlencoded'
+        }
+        header_params = self.sanitize_for_serialization(header_params)
+        post_params = self.sanitize_for_serialization(post_params)
+
+        response = self.request("POST", url,
+                                query_params=query_params,
+                                headers=header_params,
+                                post_params=post_params, body=body);
+        data = json.loads('[' + response.data + ']')
+        self.access_token = data[0]["access_token"]
+        return self;  
+
     @property
     def user_agent(self):
         """
@@ -116,7 +187,7 @@ def __call_api(self, resource_path, method,
             header_params['Cookie'] = self.cookie
         if header_params:
             header_params = self.sanitize_for_serialization(header_params)
-        header_params['purecloud-sdk'] = '57.0.0'
+        header_params['purecloud-sdk'] = '57.0.1'
 
         # path parameters
         if path_params:

build/PureCloudPlatformClientV2/api_client.py

@@ -101,6 +101,9 @@ def __init__(self):
         # client key file
         self.key_file = None
 
+        # proxy
+        self.proxy = None
+
     @property
     def logger_file(self):
         """
@@ -246,5 +249,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v2\n"\
-               "SDK Package Version: 57.0.0".\
+               "SDK Package Version: 57.0.1".\
                format(env=sys.platform, pyversion=sys.version)