GetOAuthSettings: Operation

The GetOAuthSettings operation gets settings for working with OAuth servers specified on BI server.

Comments

The operation allows for getting settings of OAuth servers used as authorization services. The settings are determined in the registry or settings.xml file in the OAuth subsection.

To execute the operation, in the tArg.svcKey field specify key of the element with authorization service settings. When the value is -1, settings of all services determined on BI server are obtained.

Example

Below is the example of getting BI server settings for working with OAuth servers.

SOAP JSON C#

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

</tArg>

</GetOAuthSettings>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<it>

<id>Google</id>

<icon>data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAB5SURBVDhPlZHJEQAhCASNy4CMx2hMxmBwPaBgxLXsJ9IyaKBHUKg5BiDmug47SnB6GeWwoLrtjVSSJ/TqIJVZODIF7r+2L4HzQBiXIWwDJOFCTTaCTEABl5Ynwh22m3hpMWCLo2D+QY35ET4wuMIXBo5lY6Jw5VEgatYLFxcSCQWXAAAAAElFTkSuQmCC</icon>

</it>

</settings>

</GetOAuthSettingsResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetOAuthSettings" : 
  {
   "tArg" : 
    {
     "svcKey" : "-1"
    }
  }
}

JSON response:

{
 "GetOAuthSettingsResult" : 
  {
   "settings" : 
    {
     "it" : 
      {
       "id" : "Google",
       "key" : "0",
       "authUrl" : "",
       "icon" : "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAB5SURBVDhPlZHJEQAhCASNy4CMx2hMxmBwPaBgxLXsJ9IyaKBHUKg5BiDmug47SnB6GeWwoLrtjVSSJ\/TqIJVZODIF7r+2L4HzQBiXIWwDJOFCTTaCTEABl5Ynwh22m3hpMWCLo2D+QY35ET4wuMIXBo5lY6Jw5VEgatYLFxcSCQWXAAAAAElFTkSuQmCC"
      }
    }
  }
}

public static GetOAuthSettingsResult GetOAuthSettings()
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetOAuthSettings()
    {
        tArg = new GetOAuthSettingsArg()
        {
            svcKey = uint.MaxValue
        }
    };
    // Get OAuth server settings determined on BI server
    var result = somClient.GetOAuthSettings(tGet);
    return result;
}

GetOAuthSettings

Syntax