EnsurePrincipal

Confirma que um Usuário ou Grupo de Segurança existe no banco de dados local do CAP e retorna os detalhes disponíveis sobre o mesmo.

Disponível no Web Service CAPSecurity.asmx

Parâmetros

  • logOnName [String]: Nome de usuário ou grupo de segurança

Exemplo de Solicitação/Resposta SOAP (v1.2)

POST /Services/CAPSecurity.asmx HTTP/1.1
Host: nossocap.capworkflow.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EnsurePrincipal xmlns="http://iteris.cap.webservices">
      <logOnName>string</logOnName>
    </EnsurePrincipal>
  </soap12:Body>
</soap12:Envelope>

---

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EnsurePrincipalResponse xmlns="http://iteris.cap.webservices">
      <EnsurePrincipalResult>
        <Id>int</Id>
        <LogOnName>string</LogOnName>
        <Name>string</Name>
        <EmployeeId>string</EmployeeId>
        <CompanyName>string</CompanyName>
        <DepartmentName>string</DepartmentName>
        <JobTitle>string</JobTitle>
        <Email>string</Email>
        <CustomProperties>string</CustomProperties>
        <ManagerBusinessKey>string</ManagerBusinessKey>
        <UserStatus>int</UserStatus>
        <Created>dateTime</Created>
        <CreatedBy>string</CreatedBy>
        <Modified>dateTime</Modified>
        <ModifiedBy>string</ModifiedBy>
        <LastLoginDate>dateTime</LastLoginDate>
        <LastActivityDate>dateTime</LastActivityDate>
        <LastPasswordChangedDate>dateTime</LastPasswordChangedDate>
        <LastLockedOutDate>dateTime</LastLockedOutDate>
        <FailedPasswordAttemptCount>int</FailedPasswordAttemptCount>
<FailedPasswordAttemptWindowStart>dateTime</FailedPasswordAttemptWindowStart>
        <Providers>
          <string>string</string>
          <string>string</string>
        </Providers>
      </EnsurePrincipalResult>
    </EnsurePrincipalResponse>
  </soap12:Body>
</soap12:Envelope>

Exemplo de Utilização em PowerShell via New-WebServiceProxy

$baseUrl = "https://env.capworkflow.com";
$userName = "test.user@capworkflow.com";
$password = "MyVeryStrongPassword@123";
# Cria o proxy para o serviço de autenticação do CAP.
$wsAuth = New-WebServiceProxy -Uri "$baseUrl/Services/CAPAuthentication.asmx" -Namespace "CAP.Services";
# Atribui um Cookie Container ao proxy para armazenar o cookie de autorização a ser retornado.
$wsAuth.CookieContainer = New-Object System.Net.CookieContainer;
# Realiza a autenticação do usuário.
$wsAuth.Login($userName, $password);
# Como o proxy do PowerShell não suporta passar as informações de autenticação no momento da sua criação,
# é necessário baixar a definição do serviço em um etapa anterior, passando o cookie de autorização através
# de uma nova sessão web.
$authSession = New-Object Microsoft.PowerShell.Commands.WebRequestSession;
$authSession.Cookies = $wsAuth.CookieContainer;
$wsSecWsdl = Invoke-WebRequest -Uri "$baseUrl/Services/CAPSecurity.asmx?wsdl" -Method Get -WebSession $authSession;
$wsSecWsdl.Content | Out-File -FilePath "D:\temp\wsSec.wsdl" -Encoding utf8;
# Cria o proxy para o serviço de configuração do CAP.
$wsSec = New-WebServiceProxy -Uri "D:\temp\wsSec.wsdl" -Namespace "CAP.Services";
# Atribui o Cookie Container com o cookie de autorização ao proxy.
$wsSec.CookieContainer = $wsAuth.CookieContainer;
$wsSec.EnsurePrincipal("usuario@capworkflow.com");

Exemplo de Utilização em PowerShell via Invoke-WebRequest

$baseUrl = "https://env.capworkflow.com";
$userName = "test.user@capworkflow.com";
$password = "MyVeryStrongPassword@123";
# Montagem da mensagem SOAP com os parâmetros de autenticação.
$soapMessage = @"
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Login xmlns="http://iteris.cap.webservices">
      <userLogOnName>$userName</userLogOnName>
      <password>$password</password>
    </Login>
  </soap12:Body>
</soap12:Envelope>
"@;
# Requisição POST passando a mensagem SOAP e armazenando
# o cookie de autorização na variável de sessão $authSession.
Invoke-WebRequest -Uri "$baseUrl/Services/CAPAuthentication.asmx" -Method Post -ContentType "application/soap+xml; charset=utf-8" -Body $soapMessage -SessionVariable authSession;
# Montagem da mensagem SOAP com os parâmetros necessários.
$secSoapMessage = @"
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EnsurePrincipal xmlns="http://iteris.cap.webservices">
      <logOnName>usuario@capworkflow.com</logOnName>
    </EnsurePrincipal>
  </soap12:Body>
</soap12:Envelope>
"@;
# Requisição POST passando a mensagem SOAP e a variável
# de sessão $authSession criada no momento da autenticação.
Invoke-WebRequest -Uri "$baseUrl/Services/CAPSecurity.asmx" -Method Post -ContentType "application/soap+xml; charset=utf-8" -Body $secSoapMessage -WebSession $authSession;

Exemplo de Utilização em PowerShell via Invoke-WebRequest e Basic Authentication

$baseUrl = "https://env.capworkflow.com";
$userName = "test.user@capworkflow.com";
$password = "MyVeryStrongPassword@123";
# Montagem da mensagem SOAP com os parâmetros necessários.
$secSoapMessage = @"
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EnsurePrincipal xmlns="http://iteris.cap.webservices">
      <logOnName>usuario@capworkflow.com</logOnName>
    </EnsurePrincipal>
  </soap12:Body>
</soap12:Envelope>
"@;
# Monta o valor do cabeçalho de autenticação para Basic Authentication.
$credential = [Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("$($userName):$password"));
# Requisição POST passando a mensagem SOAP e o cabeçalho
# de autenticação básica.
Invoke-WebRequest -Uri "$baseUrl/Services/CAPSecurity.asmx" -Method Post -ContentType "application/soap+xml; charset=utf-8" -Body $secSoapMessage -Headers @{ "Authorization" = "Basic $credential" };
Encontrou a sua resposta?