> 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/administracao-e-definicoes/permission/custom-roles.md).

# Funções personalizadas

As funções personalizadas do RealmJoin definem permissões granulares como JSON e associam-se a grupos ou utilizadores do Entra através do editor JSON incorporado.

## Visão geral

**Funções personalizadas** é uma funcionalidade opcional no RealmJoin Portal e permite criar funções internas adicionais do RealmJoin. Pode atribuir permissões granulares / atómicas a estas funções e associá-las a grupos do Entra ou a utilizadores dedicados.

{% hint style="info" %}
Se forem necessárias funções personalizadas, por favor **solicite a ativação através do suporte do RealmJoin**.
{% endhint %}

As Funções Personalizadas são definidas como JSON. O editor de JSON incluído no RealmJoin Portal oferece validação e realce de sintaxe e verificará a sua definição em relação ao esquema JSON das Funções Personalizadas.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FNifuPdTWlMiAniHWFyov%2Fimage.png?alt=media&amp;token=189d5359-6632-4d41-a9ca-14a886fce7c1" alt=""><figcaption><p>Editor de JSON de Funções Personalizadas</p></figcaption></figure>

## Utilização do editor

### Verificação de sintaxe / Erros

O editor verificará a sintaxe à medida que escreve. Se for detetado um erro de sintaxe, será apresentada uma mensagem de erro **Ver x erros** e o ícone de bug aparecerá junto de **Guardar.**

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2F9KdtoXuHIptOvZot6fHy%2Fimage.png?alt=media&amp;token=6337d312-d237-48bf-a7fa-2e0ae3ffe67f" alt=""><figcaption><p>Mensagem/botão de erro JSON</p></figcaption></figure>

Clique nesta mensagem para obter mais detalhes sobre o erro.

### Formatação

Pode formatar automaticamente o JSON clicando **Formatar** no canto superior direito da página.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FBcvly75klfY71hEA0oMj%2Fimage.png?alt=media&amp;token=009be309-82ff-4dac-828b-146c29def86e" alt=""><figcaption><p>Botão Formatar</p></figcaption></figure>

### Preenchimento automático

O editor pode oferecer preenchimento automático de palavras-chave conhecidas (como permissões) a partir do esquema.

<figure><img src="https://686519968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FwyhuLYTSuCJyhdK3K0lX%2Fimage.png?alt=media&amp;token=20ab28f4-6b98-4349-96fc-1586d609449a" alt=""><figcaption><p>Preenchimento automático de palavras-chave</p></figcaption></figure>

Pode premir "Ctrl" + "Space" a qualquer momento para invocar o preenchimento automático.

## Regras

Uma função é descrita como um par de permissões e utilizadores e/ou grupos a quem essas permissões são atribuídas.

As funções são listadas como parte de um array (lista) sob a palavra-chave **Regras**.

Exemplo de conjunto de regras:

```json
{
  "Regras": [
    {
      "Name": "Predefinição: os Supporters podem alterar o utilizador principal [27e589a7]",
      "Description": "Regra predefinida para permitir que membros de um grupo Supporter alterem o utilizador principal dos dispositivos associados ao RealmJoin. Mantenha o ID que está incluído no nome.",
      "Grupos": [
        "f31f5765-f56f-47fa-9248-ac2d77221634",
        "422e6b7c-bd99-4082-be1c-88cbc2bb2734"
      ],
      "Permissões": [
        "CanChangeRealmJoinPrimaryUser"
      ]
    },{
      "Name": "Permitir que o John adicione novos formulários de autosserviço",
      "Users": [
        "b31f5765-f56f-47fa-9248-ac2d77221622"
      ],
      "Permissões": [
        "CanAddSelfServiceForms"
      ]
    }
  ]
}
```

### Nome e descrição

**Nome** é obrigatório, **Descrição** é opcional.

Ambos são campos de texto simples (string).

### Permissões

Uma permissão é uma string única, que identifica uma determinada ação no RealmJoin Portal. **Permissões** é uma lista (array) de permissões.

Consulte [Permissões Disponíveis](https://docs.realmjoin.com/pt/administracao-e-definicoes/permission/custom-roles/available-permissions.md) para uma lista e descrição das permissões comuns.

### Grupos

Uma lista (array) de IDs de objetos de grupo do Entra. Dado [permissões](#permissions) será atribuída a todos os utilizadores que sejam membros destes grupos.

### Utilizadores

Uma lista (array) de IDs de objetos de utilizador do Entra. Dado [permissões](#permissions) será atribuída a estes utilizadores.


---

# 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/administracao-e-definicoes/permission/custom-roles.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.
