> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-references/org/applications/report-expiring-application-credentials_scheduled.md).

# Relatório agendado de credenciais de aplicações a expirar

Relatar segredos de cliente e certificados de registos de aplicações a expirar

{% hint style="info" %}
Este é um runbook agendado. Foi concebido para ser executado num agendamento recorrente, em vez de ser acionado para um único objeto. Veja [Agendamento](https://docs.realmjoin.com/pt/automatizacao/runbooks/scheduling.md) para obter detalhes sobre como configurar agendamentos de runbook.
{% endhint %}

### Descrição

Lista os segredos do cliente e os certificados dos registos de aplicações com as respetivas datas de expiração. A lista pode ser limitada a credenciais que expiram dentro de um número de dias escolhido e a determinadas aplicações. Os resultados também aparecem como tabelas no separador Dados de saída da execução. Nada é alterado. O relatório pode ser enviado por email ou disponibilizado como link de download.

### Estado da credencial

Cada credencial recebe um estado com base nos dias restantes até expirar:

* **Expirada** - a data de fim já passou (só é listado quando todas as credenciais são listadas)
* **Critical** - expira dentro de 7 dias
* **Warning** - expira dentro de *Dias antes da expiração* quando apenas as credenciais com expiração próxima são listadas, dentro de 30 dias quando todas as credenciais são listadas
* **Válida** - expira depois disso (só é listado quando todas as credenciais são listadas)

Com *Listar apenas credenciais prestes a expirar*, as credenciais já expiradas são omitidas. *Dias antes da expiração* não é usado quando todas as credenciais são listadas.

### Entrega do relatório

Os ficheiros de relatório só são gerados quando é selecionado um método de entrega através da **Entrega do relatório** opção (email e/ou link de download). Com *Apenas Output Data* selecionado, os resultados são lidos diretamente no separador Dados de saída do portal RealmJoin: uma tabela de resumo mais uma tabela por estado (*Credenciais expiradas*, *Credenciais críticas*, *Credenciais de aviso*, *Credenciais válidas*), cada uma das quais também pode ser exportada para Excel. Os ficheiros do relatório contêm todas as colunas. A entrega por email e a geração do link de download são independentes e podem ser combinadas.

Para o link de download, os ficheiros do relatório são carregados na conta de armazenamento Azure configurada nas `RJReport.StorageAccount.*` definições do Tenant, e são devolvidos links SAS de download com duração limitada. O carregamento para o armazenamento autentica-se com a identidade gerida da conta de Automation; essa identidade necessita da **Reader and Data Access** função RBAC na Storage Account de destino (esta é uma atribuição de Azure RBAC, não uma permissão de aplicação do Graph).

Quando nenhuma credencial corresponde aos filtros, nenhum ficheiro é criado. Se a entrega por email for selecionada, o email ainda é enviado, sem anexos.

Os agendamentos criados antes de a **Entrega do relatório** opção existir continuam a enviar o respetivo e-mail: um destinatário armazenado por si só ainda ativa o e-mail para eles. Quando esse agendamento é aberto para edição, a opção mostra *Apenas Output Data*; selecione novamente a entrega antes de guardar, caso contrário o agendamento deixa de enviar o relatório.

### Configuração relativa ao envio de e-mails

O envio de um relatório por e-mail é opcional e só acontece quando *Enviar também o relatório por e-mail* ou *Enviar também por e-mail e link de download* é selecionado como **Entrega do relatório**; é então necessário um destinatário. O endereço do remetente é obtido a partir do `RJReport.EmailSender` definição do Tenant.

Este runbook envia e-mails usando a API Microsoft Graph. Para enviar e-mails via Graph API, é necessário configurar um endereço de e-mail existente na personalização do runbook.

Consulte a [Documentação das definições de relatório do RealmJoin](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings) para detalhes sobre todas as definições disponíveis.

#### Branding do e-mail

O e-mail do relatório respeita as opções facultativas `RJReport.Branding.*` definições do Tenant:

* **Imagem do cabeçalho e do rodapé** - URLs HTTPS públicas, PNG/JPEG/GIF, máx. 200 KB cada
* **Link do rodapé** - destino da imagem do rodapé
* **Cor de destaque e de texto** - valores hexadecimais de 6 dígitos, por ex. `#0052cc`

Quando estas definições não estão configuradas, são utilizados os gráficos e cores predefinidos do RealmJoin. Uma imagem que não possa ser transferida ou validada, ou um valor de cor inválido, nunca impede o e-mail do relatório - é usado, em vez disso, o valor predefinido correspondente.

Instruções de configuração e requisitos de imagem: [Branding do e-mail](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings#email-branding-optional).

### Localização

Organização → Aplicações → Relatório de credenciais de aplicação a expirar (Agendado)

**Nome completo do runbook**

rjgit-org\_applications\_report-expiring-application-credentials\_scheduled

### Detalhes

| Propriedade         | Valor                                                                                                              |
| ------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Versão              | 1.6.0                                                                                                              |
| Módulos necessários | <p>RealmJoin.RunbookHelper (>= 0.8.10)<br>Microsoft.Graph.Authentication (>= 2.41.2)<br>Az.Accounts (>= 5.5.2)</p> |
| Agendável           | sim                                                                                                                |

### Permissões

#### Permissões da aplicação

* **Tipo**: Microsoft Graph
  * Application.Read.All
    * *Lê todos os registos de aplicações para avaliar as datas de expiração dos certificados e segredos*
  * Mail.Send *(opcional — funcionalidade: relatório por e-mail)*
    * *Envia o e-mail do relatório através de Send-RjRbReportEmail quando a entrega por e-mail é selecionada*
  * Organization.Read.All *(opcional — funcionalidade: relatório por e-mail)*
    * *Lê o nome de apresentação do Tenant para o assunto e o corpo do email*

#### Notas sobre permissões

Azure Storage Account: função 'Reader and Data Access' para a identidade gerida da Automation Account na Storage Account de destino - o carregamento obtém as chaves da conta via listKeys (apenas necessário para as opções de link de download)

### Parâmetros

#### listOnlyExpiring

Apenas as credenciais que expiram dentro de "Dias antes da expiração", ou todas as credenciais incluindo as expiradas.

| Propriedade                | Valor              |
| -------------------------- | ------------------ |
| Obrigatório                | false              |
| Valor predefinido          | Verdadeiro         |
| Tipo                       | Boolean            |
| Nome de exibição no portal | Quais credenciais? |

**Opções do portal**

| Opção do portal                             | Valor |
| ------------------------------------------- | ----- |
| Listar apenas credenciais prestes a expirar | true  |
| Listar todas as credenciais                 | false |

#### Dias

As credenciais que expiram dentro deste número de dias contam como prestes a expirar. Não é usado quando todas as credenciais são listadas.

| Propriedade                | Valor                   |
| -------------------------- | ----------------------- |
| Obrigatório                | false                   |
| Valor predefinido          | 30                      |
| Tipo                       | Int32                   |
| Nome de exibição no portal | Dias antes da expiração |

#### CredentialType

Segredos do cliente, certificados, ou ambos.

| Propriedade                | Valor              |
| -------------------------- | ------------------ |
| Obrigatório                | false              |
| Valor predefinido          | Ambos              |
| Tipo                       | String             |
| Nome de exibição no portal | Tipo de credencial |

**Opções do portal**

| Opção do portal                    | Valor         |
| ---------------------------------- | ------------- |
| Segredos do cliente e certificados | Ambos         |
| Apenas segredos do cliente         | ClientSecrets |
| Apenas certificados                | Certificates  |

#### ApplicationIds

Limita o relatório a estes IDs de aplicação (cliente), separados por vírgulas. Deixe em branco para todas as aplicações.

| Propriedade                | Valor              |
| -------------------------- | ------------------ |
| Obrigatório                | false              |
| Valor predefinido          |                    |
| Tipo                       | String             |
| Nome de exibição no portal | IDs das aplicações |

#### ReportFileFormat

Entregue o relatório em CSV, como um livro do Excel, ou ambos.

| Propriedade                | Valor                                           |
| -------------------------- | ----------------------------------------------- |
| Obrigatório                | false                                           |
| Valor predefinido          | CSV e XLSX                                      |
| Tipo                       | String                                          |
| Nome de exibição no portal | Formato do ficheiro do relatório                |
| Oculto no portal           | sim (predefinido via personalização do runbook) |

**Opções do portal**

| Opção do portal | Valor       |
| --------------- | ----------- |
| CSV e XLSX      | CSV e XLSX  |
| Apenas CSV      | Apenas CSV  |
| Apenas XLSX     | Apenas XLSX |

#### CreateDownloadLink

Carregue também o relatório e devolva um link de download que expira após alguns dias.

| Propriedade                | Valor                                           |
| -------------------------- | ----------------------------------------------- |
| Obrigatório                | false                                           |
| Valor predefinido          | Falso                                           |
| Tipo                       | Boolean                                         |
| Nome de exibição no portal | Criar um link de download?                      |
| Oculto no portal           | sim (predefinido via personalização do runbook) |

#### ContainerName

Contentor de armazenamento para onde os ficheiros do relatório são carregados. Definido por runbook.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido | report-expiring-app-credentials                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### ResourceGroupName

Grupo de recursos da Storage Account para carregamentos do relatório. Obtido da definição do Tenant RJReport.StorageAccount.ResourceGroup.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### StorageAccountName

Storage Account para carregamentos do relatório. Obtida da definição do Tenant RJReport.StorageAccount.StorageAccountName.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### SubscriptionId

ID da subscrição da Storage Account para carregamentos do relatório. Obtida da definição do Tenant RJReport.StorageAccount.SubscriptionId; quando estiver vazio, é usada a subscrição na qual a identidade gerida inicia sessão.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### LinkExpiryDays

Número de dias durante os quais um link de download permanece válido. Obtido da definição do Tenant RJReport.StorageAccount.LinkExpiryDays.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido | 6                                               |
| Tipo              | Int32                                           |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### SendEmailReport

Enviar o relatório para o endereço de e-mail do destinatário.

| Propriedade                | Valor                                           |
| -------------------------- | ----------------------------------------------- |
| Obrigatório                | false                                           |
| Valor predefinido          | Falso                                           |
| Tipo                       | Boolean                                         |
| Nome de exibição no portal | Enviar o relatório por email?                   |
| Oculto no portal           | sim (predefinido via personalização do runbook) |

#### EmailTo

Enviar o relatório para estes endereços. Separe vários com vírgulas; cada destinatário recebe um e-mail separado.

| Propriedade                | Valor                                           |
| -------------------------- | ----------------------------------------------- |
| Obrigatório                | false                                           |
| Valor predefinido          |                                                 |
| Tipo                       | String                                          |
| Nome de exibição no portal | Endereço(s) de e-mail do destinatário           |
| Oculto no portal           | sim (predefinido via personalização do runbook) |

#### EmailFrom

Endereço do remetente do e-mail do relatório. Obtido da definição do Tenant RJReport.EmailSender.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### BrandingHeaderImageUrl

Imagem do cabeçalho do e-mail do relatório (URL HTTPS, PNG/JPEG/GIF, máx. 200 KB). Obtida da definição do Tenant RJReport.Branding.HeaderImageUrl; o cabeçalho predefinido do RealmJoin é usado quando estiver vazio.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### BrandingFooterImageUrl

Imagem do rodapé do e-mail do relatório (URL HTTPS, PNG/JPEG/GIF, máx. 200 KB). Obtida da definição do Tenant RJReport.Branding.FooterImageUrl; o rodapé predefinido do RealmJoin é usado quando estiver vazio.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### BrandingFooterLink

Link associado à imagem do rodapé do e-mail do relatório. Obtido da definição do Tenant RJReport.Branding.FooterLink; realmjoin.com é usado quando estiver vazio.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### BrandingAccentColor

Cor de destaque do e-mail do relatório como um valor hexadecimal de 6 dígitos. Obtida da definição do Tenant RJReport.Branding.AccentColor; o valor predefinido do RealmJoin é usado quando estiver vazio ou inválido.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

#### BrandingTextColor

Cor do texto do e-mail do relatório como um valor hexadecimal de 6 dígitos. Obtida da definição do Tenant RJReport.Branding.TextColor; o valor predefinido do RealmJoin é usado quando estiver vazio ou inválido.

| Propriedade       | Valor                                           |
| ----------------- | ----------------------------------------------- |
| Obrigatório       | false                                           |
| Valor predefinido |                                                 |
| Tipo              | String                                          |
| Oculto no portal  | sim (predefinido via personalização do runbook) |

[Voltar à visão geral da referência do runbook](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-references.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-references/org/applications/report-expiring-application-credentials_scheduled.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
