Webex Connect (CPaaS)
Authentication
Use a Webex personal access token to authenticate requests to the digital asset APIs for Email and Chat assets. Chat assets support Push Notifications, Live Chat, and In-App Messaging.
anchorHow access is evaluated
anchorAuthentication verifies the token and identifies the Webex user. Authorization then verifies that:
- The token contains the scope required for the digital asset operation.
- The user can access the organization identified by
x-organization-id. - The user has permission to manage the requested asset.
The required token scope permits the API operation; it does not grant organization access or a higher administrative role.
anchorSend the personal access token
anchorInclude the token in each request to a digital asset API using the bearer scheme:
Authorization: Bearer <personal-access-token>
Do not send the token as a query parameter or in the request body.
anchorIdentify the organization
anchorInclude the organization ID in the x-organization-id header. The organization must be associated with the user represented by the token.
x-organization-id: <organization-id>
anchorUse a personal access token
anchorUse a personal access token to explore operations in Try Out, verify permissions and request formats, and develop against the Email and Chat digital asset APIs. For steps to get a token, see Personal Access Token.
The required scope is documented for each API operation in the Digital Asset API Reference. Other Webex Connect API families may use different authentication methods; see API Authentication and IP Allowlisting.
anchorProtect the token
anchor- Do not commit personal access tokens to source control.
- Do not include personal access tokens in browser code, screenshots, or support tickets.
- Remove the
Authorizationheader and token values from application logs. - Obtain a new token after the current token expires.
- Request only the scopes needed for the asset operations you are testing.