Instância do Admin

Configuração de instância é tudo que um operador pode alterar em tempo de execução. Ela abrange login único, rollout do Gateway, política de registro, links legais e de marca, política de instância, integrações de terceiros, retenção de mídia e configuração ordenada de limites. O recurso Instância serve o subconjunto publicado para clientes não autenticados.

Toda escrita é uma mesclagem sobre a configuração armazenada, e uma chave omitida deixa o valor armazenado inalterado. A escrita na configuração de limites é a única exceção e substitui o documento armazenado.

Ler configurações requer a ACL Admin instance:config:view, e gravá-las requer instance:config:update. A configuração de limites tem seu próprio par, instance:limit_config:view e instance:limit_config:update.

A configuração inicial aceita uma credencial de sessão simples

Até a configuração ser marcada como concluída, Obter configuração da instância, Atualizar configuração da instância, Criar ativo de marca e Criar teste SMTP também aceitam uma credencial de sessão não possuindo ACL Admin.

Essa flexibilização se aplica apenas a uma credencial de sessão, de forma que uma chave da API Admin e um token portador (bearer token) são avaliados normalmente mesmo antes da configuração estar completa. A conclusão da configuração concede à sessão o ACL de curinga. URLs de registro, registros pendentes e a configuração de limite exigem sempre a sua própria ACL.

Nenhuma leitura retorna um segredo armazenado

Um segredo é relatado por um boleano companheiro tal como client_secret_set. Exceto para o segredo de cliente do login único, esse boleano é verdadeiro quer o valor esteja armazenado aqui ou fornecido pela configuração de implantação.

Objeto de configuração da Instância

A configuração de tempo de execução completa da implantação. Cada operação de configuração aqui, com exceção da de limites, retorna isto.

Configurações não indicadas usam os padrões documentados a seguir. Uma configuração inválida causará um erro ao invés de ignorar de vez a modificação nas normas ou padrões. Os administradores poderão se servir nas dicas ao abrigo da diretiva de políticas no alojamento (stored instance policy).

Estrutura

Campo	Tipo	Descrição
sso	Objeto SSO configuration	Configurações do serviço para login unificado (Single sign-on)
gateway_rollout	Objeto Gateway rollout configuration	Tratamento, entrega (rollout) e regulação na alocação ao sistema em Gateway
voice_noise_suppression	Objeto voice noise suppression configuration	Execução na filtragem sonora pelo terminal aos utilizadores (client-side)
experiment_delivery	Objeto experiment delivery configuration	Ciclo de verificação em que instâncias acedem ou consultam atualizações nas experiências e validações associadas
registration	Objeto registration configuration	Políticas relativas aos parâmetros submetidos nas validações atinentes à adesões ou acessos de novas entidades e registros associados nas esperas de parecer
self_hosted	boolean	Quando e onde as avaliações decorrem no domínio ou servidor particular do instalador (self-hosted mode)
app_public	Objeto public application configuration	Identidades (Branding), políticas legais relativas aos envios ou admissão perante dados submetidos à registro e afins
policy	Objeto instance policy	Critérios do sistema relativas aos domínios privados nas transmissões individuais, subscrições adicionais pagas ou condicionantes de entrada
integrations	Objeto instance integrations	Domínios associados as configurações fornecidas e disponibilizadas pelos apoios às vertentes vindas e integradas através de entidades secundárias
media	Objeto instance media	Retenções aplicáveis a componentes integrados via anexos nas transmissões textuais

Objeto de Configuração SSO

As informações a associar e acionar no modelo de autenticações integradas relativas ao protocolo dos registos das entidades em uso ou OpenID Connect.

Estrutura

Campo	Tipo	Descrição
enabled	boolean	Aplica ou rejeita opções vinculadas ao modelo base Single sign-on
enforced1	boolean	Aplica e exige a referida opção como porta no modelo único ou único no acesso a entradas de instâncias à plataforma associada
display_name	?string	Nomenclaturas fornecida ou exibidas durante preenchimento no formulário na respectiva ligação à plataforma
issuer	?string	Emitente em OpenID Connect
authorization_url	?string	Link perante aprovação nas permissões (authorization endpoint)
token_url	?string	Endereço com referencial atinente a chaves no emissor (token endpoint)
userinfo_url	?string	Endereço atinente a obtenção em relatórios a avaliações em utilizador
jwks_url	?string	Ponto nos acessos em JWKS
client_id	?string	Identidades referentes de vinculação
client_secret_set	boolean	Oculta dados aos domínios com segredo restrito perante avaliação do alojamento ao Decoding Chat
scope	?string	Texto delimitativo associado com espaço na abrangência aos dados no registo (scope)
allowed_domains2	array[string]	Extensões eletrónicas associáveis e liberadas na admissão de entrada ao sistema principal (no topo de alocações: 100)
auto_provision	boolean	Associa criação à ação inicial de conexão nos registros referenciados na entrada à avaliação originária
redirect_uri3	?string	Destino no retorno as verificações aos termos fornecidos a associarem o registo e admissões nas aprovações do serviço atinente

¹ Na instância numa situação isenta aos envios as leituras acompanham ou referenciam-se a si e aos domínios e avaliações às informações relativas na alínea enabled ² No ato do armazenamento as inserções assumem e reduzem a escrita para minúsculas nas alocações IDNA. Na situação na qual a gravação foca duplos, o mesmo as limpa nas entradas idênticas omitindo o valor associado ao se identificar uma submissão num bloco sem indicações ou envio num formulário ³ Associações do formulário nos serviços às verificações em endereços adicionadas através na referência no acesso aos acessos com premissas ao parâmetro da aba atinente /auth/sso/callback. Nulifica em operação sem opções para mudanças neste parâmetro