Webex API
Login and Navigate to Interfaces > Add Interface
Select Webex API (OAuth2 - Cloud) as the Type
...
The same interface can be used for Wrangler_ and test_mate , each of these require different Scope permissions. This example will show setting up Wrangler_ for Webex Scopes.
Press Submit
...
Info |
---|
Proxy is optional, Internet access is required to access https://webexapis.com/ from Yarnman |
When the page saves, Press show Scopes
These are the requires roles to be configured on your webex integration
...
Open a new Tab/Browser to Create a new Webex integration https://developer.webex.com/my-apps
...
Complete the required fields (we will come back to the redirect uri), select or upload a logo, scroll down to select the scopes to match the ones shown from Yarnman
...
Switch back to Yarnman and select the Arm Bindings tab
Select the Yarnman node in the dropdown followed by pressing Bind to Arm
...
Copy the URL that is shown as Redirect URL and switch back to Webex
Paste in the URl to the URL field, make sure to remove any leading Spaces or Tabs that may come through
...
Press Add in Webex
Make note of the Client ID , Client Secret ( NOTE this won;t be shown again, however it can be regenerated if lost)
...
Switch back to Yarnman
press Update / Set Credentials
Populate
Application with either the same as your called it in Webex or something meaningful.
Client ID as string provided by Webex
Redirect URI as the one provided by yarnman and press submit
...
The popup will refresh with an Authorise button with the confirmed details, Press Authorise
...
Note |
---|
The web browser will required Internet Access and Access to Yarnman, Please make sure your Jumpbox or Proxy settings in the browser allow for this configuration , you may need to bypass the IP address of Yarnman if you have a proxy in your browser. |
The webex authentication screen will be presented. Depending on your environment this could be handled by Webex or your SSO provider. Eg Microsoft.
Webex will prompt you to allow or deny the permissions associated with your account
...
Press accept and log back into yarnman when it redirects Paste in the Client secret
...
Token details will be stored
...
Test Connection can pressed to verify Yarnman can access Webex API doing a simple about me api request.
Troubleshooting Scopes
Yarnman can help validate the scopes configured in your webex app
Copy the whole URL from webex
...
Press Validate Scopes in Yarnman
...
Paste the URL in the popup from Yarnman
...
Press validate , Yarnman will advise the roles that need to be checked on the webex app
...
Troubleshooting Webex login
Where possible its best to use an Private/Incognito session to preform the oAuth flow. As there could be issues with cached logins with SSO , or the wrong SSO id being prompted and causing the oAuth to fail with change of UserID midsession.