xapirest.properties

Use o arquivo customer_overrides.properties para substituir propriedades em xapirest.properties. *.

O arquivo xapirest.properties permite as mesmas opções de configuração que yifclient.properties e controla onde ocorrem chamadas XAPI. Chamadas XAPI são configuradas como LOCAL por padrão.

A tabela a seguir lista configurações customizadas no xapirest.properties:

Propriedade Valores Descrição
servlet.jwt.auth.enabled

true

false (Padrão)

Se essa propriedade for configurada como true, a autenticação JWT para APIs de REST será ativada
Nota:
  • Para uma determinada solicitação, pode haver apenas um único cabeçalho "Authorization" com esquema "Basic" ou "Bearer".
  • Quando essa propriedade for ativada e se o cabeçalho "Authorization" na solicitação recebida contiver um esquema "Bearer" com um valor de token não em branco, esse token terá precedência para autenticação sobre as opções de autenticação convencionais existentes fornecidas que usam a propriedade servlet.authstyle .
servlet.authstyle CONTÊINER

CONTAINER_USER (Padrão)

PADRÃO

ABERTO

EXTENDED

básico

CONTAINER requer que um usuário seja autenticado pelo contêiner de aplicativo com o userid especificado por servlet.userid.

CONTAINER_USER requer que um usuário seja autenticado pelo contêiner de aplicativo usando o nome Principal identificado como o userid.

STANDARD requer a passagem dos parâmetros _loginid e _token para autenticação.

OPEN sempre autentica o userid especificado por servlet.userid sem autenticação extra.

O EXTENDED usa servlet.ssomanager ou yfs.login.singlesignon.class de yfs.properties para uma implementação de SSO customizada.

BASIC chama a API de login com o usuário e senha especificados no cabeçalho de Autorização da solicitação. Nenhum token do usuário é criado ou retornado

servlet.userid ID do usuário Especifica um userid para fazer chamadas API. Um ID do usuário deve ser configurado quando servlet.authstyle for configurado como CONTAINER ou OPEN
servlet.ssomanager classe Declara a classe de implementação de YCPSSOManager quando servlet.authstyle é configurado como EXTENDED
servlet.put.enabled

true

false (Padrão)

Permite que PUT seja usado para chamar APIs de Modificação se configurado como true. PUT se comporta exatamente como PATCH.
servlet.realm prompt Um prompt customizado que pode ser exibido durante a autenticação BASIC..
servlet.cors.enabled

true

false (Padrão)

Se essa propriedade for configurada como true, o suporte Cross Original Resource Sharing (CORS) nas APIs REST será ativado. Todas as outras propriedades de suporte CORS serão aplicáveis somente se essa propriedade for configurada como true
servlet.cors.max.age Valores válidos = <número de segundos>

Padrão = 3600

Determina o intervalo de tempo (em segundos) para o qual os resultados da solicitação de pré-voo são armazenados em cache em cache de resultados de pré-voo pelo navegador. Corresponde ao cabeçalho de resposta HTTP , "Access-Control-Max-Age".
servlet.cors.allow.credentials

true (Padrão)

false

Indica se o navegador tem permissão para enviar credenciais ao servidor. Ele corresponde ao cabeçalho de resposta HTTP , "Access-Control-Allow-Credentials".
servlet.cors.allow.origin Valores válidos = <valores separados por vírgula de domínios do host (protocol://hostname: [portno])>

Padrão = *

Determina a lista de domínios de host permitidos.. Corresponde ao cabeçalho de resposta HTTP , "Access-Control-Allow-Origin". O número [portno] é opcional. Essa propriedade pode aceitar um valor único de curinga (*) para permitir acesso para qualquer origem.
O Nota: IBM® recomenda não usar o valor padrão de "*" no ambiente de produção.
servlet.cors.expose.headers Valores válidos = <valores separados por vírgula de HTTP cabeçalhos>

O padrão não está configurado.

Determina a lista de cabeçalho HTTP que podem ser acessados por um navegador. Corresponde ao cabeçalho de resposta HTTP , "Access-Control-Expose-Headers".
servlet.cors.allow.headers Valores válidos = <valores separados por vírgula de HTTP cabeçalhos> Determina a lista de cabeçalho HTTP permitidos. Ele corresponde ao cabeçalho de resposta HTTP , "Access-Control-Allow-Headers". O valor dessa propriedade é retornado na resposta para uma solicitação de pré-voo.. Por padrão, o valor dessa propriedade é igual ao valor do cabeçalho da solicitação recebida, "Access-Control-Request-Headers".
servlet.cors.allow.methods Valores válidos = <valores separados por vírgula de HTTP métodos> Determina a lista de métodos de HTTP permitidos Corresponde ao cabeçalho de resposta HTTP , "Access-Control-Allow-Methods". O valor dessa propriedade é retornado na resposta para uma solicitação de pré-voo.. Por padrão, o valor dessa propriedade é igual ao valor do cabeçalho da solicitação recebida, "Access-Control-Request-Method".