Scripts de Identity Server

Execute o script Publish-IdentityServer.ps1 para implantação inicial ou atualização do Identity Server.

Publicar no Identity Server

A tabela a seguir descreve todos os parâmetros que você pode usar com o script Publish-IdentityServer.ps1.

Parâmetro	Description
-action	Mandatory. Indicates the type of scenario you want to start. As seguintes opções estão disponíveis: Deploy - especifica que é uma instalação limpa. Update- especifica que você está atualizando sua instância de Identity Server.
-azureAccountApplicationId	Mandatory. The Azure service principal ID. Please note that the used service principal needs to be assigned the Contributor role to the app service at the subscription scope.
-azureAccountPassword	Obrigatório. O token de acesso do Azure para o ID principal do serviço.
-azureSubscriptionId	Obrigatório. O ID de assinatura do Azure para o Serviço de Aplicativo que hospeda o Orchestrator.
-azureAccountTenantId	Obrigatório. O ID de tenant do Azure.
-orchestratorUrl	Obrigatório. O URL da instância do Orchestrator.
-identityServerUrl	Obrigatório. A URL do Identity Server. Important: The URL must contain the Identity Server address + the suffix /identity in lowercase. Exemplo: https://[identity_server]/identity
-resourceCatalogUrl	Obrigatório. A URL do catálogo de recursos.
-orchDetails	Esse parâmetro é uma tabela de hash que contém os seguintes valores: resourceGroupName - Obrigatório. O nome do Grupo de Recursos do Azure que contém o Serviço de Apps do Orchestrator. appServiceName - Obrigatório. O nome do Serviço de App do Azure via Orchestrator. targetSlot - Obrigatório. O slot do Serviço do Aplicativo de Destino definido pelo Azure.
-identityServerDetails	Esse parâmetro é uma tabela de hash que contém os seguintes valores: resourceGroupName - Obrigatório. O nome do Grupo de Recursos do Azure que contém o Serviço de Aplicativo do Identity Server. appServiceName - Obrigatório. O nome do Serviço de Aplicativo do Azure do Identity Server. targetSlot - Obrigatório. O slot do Serviço do Aplicativo de Destino definido pelo Azure.
-package	Obrigatório. Indique o caminho completo ou o caminho relativo do arquivamento UiPath.IdentityServer.Web.zip.
-cliPackage	Obrigatório. Indique o caminho completo ou o caminho relativo do arquivamento UiPath.IdentityServer.Migrator.Cli.zip.
-productionSlotName	Opcional. Ele pode ser usado apenas se o slot de implantação do Serviço de Aplicativo do Identity Server for diferente do slot de Serviço de Aplicativo de produção padrão definido pelo Azure.
-stopApplicationBeforePublish	Opcional. Se presente, ele interrompe a aplicação antes da implantação e reinicia após a conclusão da implantação.
-unattended	Opcional. Se presente, a implantação continua sem qualquer confirmação do usuário.
-tmpDirectory	Opcional. Permite a especificação de um diretório em que os arquivos necessários são baixados e descompactados.
-noAzureAuthentication	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the UseServicePrincipal parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.

O script Publish-IdentityServer.ps1 é usado para a implantação inicial ou atualização do Identity Server. O script pressupõe que o aplicativo da Web já tenha a string de conexão do banco de dados DefaultConnection configurada.

.\Publish-IdentityServer.ps1 `
    -action Deploy `
    -orchestratorUrl "<orchestrator_address>" `
    -identityServerUrl "https://<identity_server_url>/identity" ` // must be in lowercase
    -resourceCatalogUrl "<resource_catalog_address>" `
    -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
    -identityServerDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" } `
    -azureSubscriptionId "<subscription_id>" `
    -azureAccountTenantId "<azure_tenant_id>" `
    -azureAccountApplicationId "<azure_application_id>" `
    -azureAccountPassword "<azure_account_password>" `
    -package "UiPath.IdentityServer.Web.zip" `
    -cliPackage "UiPath.IdentityServer.Migrator.Cli.zip" `
    -stopApplicationBeforePublish `
    -unattended

Importante:

Após executar o script acima, certifique-se de executar as etapas extras listadas abaixo para uma implantação inicial bem-sucedida.

Após publicar o Identity Server, execute as seguintes etapas:

1. Acesse o Portal do Azure.
2. Selecione seu Serviço de Aplicativo do Identity Server.
3. No menu Certificados, acesse Trazer seus próprios certificados.
4. Carregue um arquivo de certificado de chave privada .pfx com uma senha válida.
   Observação:

   Esse certificado é usado para assinar os tokens de acesso e os tokens de ID.

5. No menu Configuração, adicione as seguintes configurações de aplicativo exatamente como escrito na coluna Configurações do Aplicativo:

Configuração de aplicativos	Valor	Description
AppSettings__IdentityServerAddress	https://[identity_server]/identity	O URL pública do Identity Server. Importante: o URL deve conter o endereço do Identity Server + o sufixo /identity em letras minúsculas.
AppSettings__SigningCredentialSettings__StoreLocation__Location	Usuário atual	Ela deve apontar para CurrentUser.
AppSettings__SigningCredentialSettings__StoreLocation__Name	XXXXXXXXXXXXXXXXXXXXXXXXXXXX	A impressão digital do seu certificado que você carregou anteriormente.
AppSettings__SigningCredentialSettings__StoreLocation__NameType	Thumbprint	Enter Thumbprint como o tipo do campo anterior.
AppSettings__LoadBalancerSettings__RedisConnectionString	XXXXXXXXXXXX:XXXX,password=XXXXXX	The connection string needed to set up your Redis server, which contains the URL of the server, the password, and the port. You can also enable SSL encrypted connections between the Orchestrator nodes and the Redis service.
AppSettings__LoadBalancerSettings__SlidingExpirationTimeInSeconds	Número de segundos	The sliding expiration time of an item inside the cache. This expiration time applies to both Redis Cache and InMemory Cache.
AppSettings__RedisSettings__UseRedisStoreCache	true / false	Defina seu valor como true to enable Redis caching of OAuth client data. This helps prevent performance issues when using Interactive Sign In to connect a large number of robots in a short amount of time. This cache uses the same Redis connection string specified in the AppSettings__LoadBalancerSettings Observação: isso não é recomendado se você estiver usando a funcionalidade Aplicativos externos, pois essa configuração armazena em cache os clientes, e as atualizações para Aplicativos externos não serão refletidas.
AppSettings__RedisSettings__UseRedisStoreClientCache	true / false	Set its value to true to enable Redis caching for first-party clients (UiPath applications) or third-party clients (external applications). If you have a large-scale deployment, it is recommended to enable this flag.
App__Saml2ValidCertificateOnly	true / false	Para implantações do Orchestrator por meio de um aplicativo web do Azure, esse parâmetro deve ser definido como false . This is because SAML2 requires certificates to be added to its trust store, but Azure web apps do not allow this action. Setting the value to false significa que a verificação do certificado é ignorada.
WEBSITE_LOAD_CERTIFICATES	XXXXXXXXXXXXXXXXXXXXXXXXXXXX	O valor da impressão digital do seu certificado que você carregou anteriormente.
WEBSITE_LOAD_USER_PROFILE	1	O perfil do usuário.
-azureUSGovernmentLogin	Opcional. Este parâmetro é usado apenas para implantações do Governo dos EUA.

6.

Salve as alterações.

Encontre mais detalhes na documentação do Microsoft Azure.

Substituição do certificado de chave privada

Ao substituir um certificado de chave privada por um novo, certifique-se de seguir estas etapas:

1. Substitua os valores dos parâmetros AppSettings__SigningCredentialSettings__StoreLocation__Name e WEBSITE_LOAD_CERTIFICATES pela impressão digital do novo certificado.
2. Reinicie o serviço do aplicativo Identity.
3. Reinicie o serviço do aplicativo do Orchestrator.

Migrar para o Identity Server

A seguinte tabela descreve todos os parâmetros que podem ser usados com a MigrateTo-IdentityServer.ps1.

Parâmetro	Description
-cliPackage	Mandatory . Indique o caminho completo ou o caminho relativo do arquivamento UiPath.IdentityServer.Migrator.Cli.zip.
-azureDetails	Esse parâmetro é uma tabela de hash que contém os seguintes valores: azureAccountApplicationId - Mandatory. The Azure service principal ID. Please note that the used service principal needs to be assigned the Contributor role to the app service at the subscription scope. azureSubscriptionId - Obrigatório. O ID de assinatura do Azure para o Serviço de Aplicativo que hospeda o Orchestrator. azureAccountTenantId - Obrigatório. O ID de tenant do Azure. azureAccountPassword - Obrigatório. O token de acesso do Azure para o ID principal do serviço.
-orchDetails	Esse parâmetro é uma tabela de hash que contém os seguintes valores: resourceGroupName - Obrigatório. O nome do Grupo de Recursos do Azure que contém o Serviço de Apps do Orchestrator. appServiceName - Obrigatório. O nome do Serviço de App do Azure via Orchestrator. targetSlot - Obrigatório. O slot do Serviço do Aplicativo de Destino definido pelo Azure.
-identityServerDetails	Esse parâmetro é uma tabela de hash que contém os seguintes valores: resourceGroupName - Obrigatório. O nome do Grupo de Recursos do Azure que contém o Serviço de Aplicativo do Identity Server. appServiceName - Obrigatório. O nome do Serviço de Aplicativo do Azure do Identity Server. targetSlot - Obrigatório. O slot do Serviço do Aplicativo de Destino definido pelo Azure.
-identityServerUrl	Obrigatório. O endereço público do Identity Server. Important: The URL must contain the address of Identity Server + the suffix /identity in lowercase. Exemplo: https://[identity_server]/identity
-orchestratorUrl	Obrigatório. O endereço público do Orchestrator.
-tmpDirectory	Opcional. Permite a especificação de um diretório em que os arquivos necessários são baixados e descompactados.
-hostAdminPassword	Obrigatório apenas para novas implantações, quando-action is set to Deploy . Specify a custom password for the host administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.
-isHostPassOneTime	Optional. Enables you to enforce a password reset on the first login for the host administrator. If this parameter is omitted, the host admin password is not a one-time password.
-defaultTenantAdminPassword	Obrigatório apenas para novas implantações, quando-action is set to Deploy . Specify a custom password for the default tenant administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.
-isDefaultTenantPassOneTime	Optional. Enables you to enforce a password reset on the first login for the default tenant administrator. If this parameter is omitted, the tenant admin password is not a one-time password.
-noAzureAuthentication	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the UseServicePrincipal parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.

O script MigrateTo-IdentityServer.ps1 é usado para migrar dados do usuário do Orchestrator para o Identity Server e definir as configurações para ambos. Ele define a autoridade de identidade do Orchestrator para o Identity Server e cria a configuração do cliente para o Orchestrator no Identity Server.

O script pressupõe que o Orchestrator e o Identity Server já estejam publicados.

.\MigrateTo-IdentityServer.ps1 `
    -cliPackage "UiPath.IdentityServer.Migrator.Cli.zip" `
    -azureDetails @{azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } `
    -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
    -identityServerDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" } `
    -identityServerUrl "https://<identity_server_url>/identity" ` // must be in lowercase
    -orchestratorUrl "https://<OrchestratorURL>" `
    -hostAdminPassword "12345qwert" `
    -defaultTenantAdminPassword "12345qwert"