GetExtServiceSettings

Syntax

GetExtServiceSettingsResult GetExtServiceSettings(GetExtServiceSettingsArg tArg)

Parameters

tArg. Operation execution parameters.

Description

The GetExtServiceSettings operation gets settings of the external authentication service, which the repository is set up to work with.

Comments

The operation enables the user to get address of the external service specified in repository settings. Settings are determined in the registry/ settings.xml file. To execute the operation, in the tArg.mbId field specify repository description identifier. Repository description is set in the Metabases.xml file.

The operation results in the obtained external service settings.

Example

Below is the example of getting settings of the external authentication service, which the repository is set up to work with. The request contains repository description identifier. The response contains the obtained settings.

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">
<GetExtServiceSettings xmlns="http://www.fsight.ru/PP.SOM.Som">
<tArg xmlns="">
  <mbId>TEST_JWT</mbId>
  </tArg>
  </GetExtServiceSettings>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetExtServiceSettingsResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<settings xmlns="">
  <id>JWT_PROVIDER</id>
  <authUrl>https://example.com/jwt/login</authUrl>
  </settings>
  </GetExtServiceSettingsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetExtServiceSettings" : 
  {
   "tArg" : 
    {
     "mbId" : "TEST_JWT"
    }
  }
}

JSON response:

{
 "GetExtServiceSettingsResult" : 
  {
   "settings" : 
    {
     "id" : "JWT_PROVIDER",
     "authUrl" : "https://example.com/jwt/login"
    }
  }
}
public static GetExtServiceSettingsResult GetExtServiceSettings(string metabaseDefinitionId)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetExtServiceSettings()
    {
        tArg = new GetExtServiceSettingsArg()
        {
            mbId = metabaseDefinitionId
        }
    };
    // Get external service settings
    var result = somClient.GetExtServiceSettings(tGet);
    return result;
}

See also:

Working with Repository