Connecting to Webex

To authenticate to Webex, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with Webex. To do so, navigate to the Webex Developer Portal and create a new integration. Your OAuth application will be assigned a client id and a client secret.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to the client_id that is specified in your app settings.
OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
CallbackURL: Set this to the Redirect URI that is specified in your app settings.
Scope: Set this in ProfileSettings to specify the OAuth scopes requested during authorization. Multiple scopes can be space-separated (e.g. ProfileSettings='Scope=spark:all spark:kms').

Example connection string:

Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';

Usage Examples

AdminAuditEvents:

SELECT * FROM AdminAuditEvents WHERE OrgId = 'org123' AND From = '2024-01-01 00:00:00' AND To = '2024-01-31 23:59:59'

AttachmentActions:

SELECT * FROM AttachmentActions WHERE Id = 'attachmentActionId123'

AutoAttendantDetails:

SELECT * FROM AutoAttendantDetails WHERE LocationId = 'location123' AND Id = 'autoAttendant123'

AutoAttendants:

SELECT * FROM AutoAttendants

CallHistory:

SELECT * FROM CallHistory

CallQueueDetails:

SELECT * FROM CallQueueDetails WHERE LocationId = 'location123' AND Id = 'callQueue123'

CallQueues:

SELECT * FROM CallQueues

Devices:

SELECT * FROM Devices

Events:

SELECT * FROM Events

HuntGroupDetails:

SELECT * FROM HuntGroupDetails WHERE LocationId = 'location123' AND Id = 'huntGroup123'

HuntGroups:

SELECT * FROM HuntGroups

Licenses:

SELECT * FROM Licenses

Locations:

SELECT * FROM Locations

MeetingInvitees:

SELECT * FROM MeetingInvitees WHERE MeetingId = 'meeting123'

MeetingParticipants:

SELECT * FROM MeetingParticipants WHERE MeetingId = 'meeting123'

MeetingRegistrants:

SELECT * FROM MeetingRegistrants WHERE MeetingId = 'meeting123'

MeetingSummaries:

SELECT * FROM MeetingSummaries WHERE MeetingId = 'meeting123'

MeetingTemplates:

SELECT * FROM MeetingTemplates

MeetingTranscripts:

SELECT * FROM MeetingTranscripts

Meetings:

SELECT * FROM Meetings

Memberships:

SELECT * FROM Memberships

Messages:

SELECT * FROM Messages WHERE RoomId = 'room123'

Organizations:

SELECT * FROM Organizations

People:

SELECT * FROM People WHERE Email = '[email protected]'

PhoneNumbers:

SELECT * FROM PhoneNumbers

Recordings:

SELECT * FROM Recordings

Roles:

SELECT * FROM Roles

RoomTabs:

SELECT * FROM RoomTabs WHERE RoomId = 'room123'

Rooms:

SELECT * FROM Rooms

Schedules:

SELECT * FROM Schedules WHERE LocationId = 'location123'

TeamMemberships:

SELECT * FROM TeamMemberships WHERE TeamId = 'team123'

Teams:

SELECT * FROM Teams

TranscriptSnippets:

SELECT * FROM TranscriptSnippets WHERE TranscriptId = 'transcript123'

VirtualLines:

SELECT * FROM VirtualLines

Workspaces:

SELECT * FROM Workspaces

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authentication. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
Scope	Scope(s) to use when authenticating, that control access to specific information.