METHOD_GetAuthenticationInfo

This method sends a query to BEMS for authentication related information for Microsoft Entra ID tasks. For example,
  • If the environment uses Skype for Business on-premises, BEMS returns a login url. Auto discovery must be enabled.
  • If the environment uses Skype for Business using non-trusted application mode, no authentication information is returned.
  • If the environment uses Cisco Unified Communications Manager for IM and Presence.

Call this method before the METHOD_BeginSession so that an access token can be generated.

Parameter

 Type Required

Description

GDAuthToken

 String √

This parameter specifies the access token that is generated for BlackBerry Dynamics apps.

This parameter can be passed in instead of through the X-Good-GD-AuthToken.

BEMS response and notification

The following table describes the parameters that BEMS returns, and the notification sent to the BlackBerry Connect app when a chat session is started.

Parameter

Type

Description

authDataType

String

Returns the authentication information that is used in the access token.
method String Returns the invoked method (for example, GetAuthenticationInfo).
state String This parameter specifies the state of the request to BEMS (for example, Processing or Complete).

Code example

The following example sends a query to BEMS to obtain authentication information to generate an access token.

{
  "id":"c1",
  "method":"GetAuthenticationInfo",
  "params":
   {
     "gdAuthToken":"d64a57b7-f5b5-4e3a-839b-00618653a090"
   },
 "jsonrpc":"2.0"
}

If the request is successful, BEMS sends the following response to the BlackBerry Connect app and processes the request.

{
  "id":"c1",
  "error":null,
  "result":
     {
       "data":
         {
       "method":"GetAuthenticationInfo",
       "loginUrl":"https://webext.gems.cbbcps.com/WebTicket/oauthtoken",
       "authDataType":"WindowsAccessToken",
       "state":"COMPLETE"
         }
     },
  "jsonrpc":"2.0"
}