xapirest.properties

Utilice el archivo customer_overrides.properties para alterar temporalmente las propiedades en xapirest.properties. *.

El archivo xapirest.properties permite las mismas opciones de configuración que yifclient.properties y controla dónde tienen lugar las llamadas XAPI. Las llamadas XAPI se establecen en LOCAL de forma predeterminada.

La tabla siguiente lista configuraciones personalizadas en xapirest.properties:

Propiedad Valores Descripción
servlet.jwt.auth.enabled

true

false (Valor predeterminado)

Si esta propiedad se establece en true, la autenticación JWT para las API REST está habilitada.
Nota:
  • Para una solicitud determinada, sólo puede haber una única cabecera "Authorization" con el esquema "Basic" o "Bearer".
  • Cuando esta propiedad está habilitada y si la cabecera "Authorization" de la solicitud de entrada contiene un esquema "Bearer" con un valor de señal no en blanco, esta señal tiene prioridad para la autenticación sobre las opciones de autenticación convencionales existentes proporcionadas que utilizan la propiedad servlet.authstyle .
servlet.authstyle CONTAINER

CONTAINER_USER (valor predeterminado)

ESTÁNDAR

ABIERTO

EXTENDED

BÁSICO

CONTAINER requiere que el contenedor de aplicaciones autentique a un usuario con el ID de usuario especificado por servlet.userid.

CONTAINER_USER requiere que el contenedor de aplicaciones autentique a un usuario utilizando el nombre de principal identificado como userid.

STANDARD requiere el paso de los parámetros _loginid y _token para la autenticación.

OPEN siempre autentica el userid especificado por servlet.userid sin autenticación adicional.

EXTENDED utiliza servlet.ssomanager o yfs.login.singlesignon.class de yfs.properties para una implementación SSO personalizada.

BASIC llama a la API de inicio de sesión con el usuario y la contraseña especificados en la cabecera de autorización de la solicitud. No se crea ni se devuelve ninguna señal de usuario.

servlet.userid ID de usuario Especifica un userid para realizar llamadas de API. Se debe establecer un userid cuando servlet.authstyle se establece en CONTAINER u OPEN.
servlet.ssomanager clase Declara la clase de implementación de YCPSSOManager cuando servlet.authstyle se establece en EXTENDED.
servlet.put.enabled

true

false (Valor predeterminado)

Permite que se utilice PUT para llamar a las API de modificación si se establece en true. PUT se comporta exactamente como PATCH.
servlet.realm solicitud Una solicitud personalizada que se puede visualizar durante la autenticación BASIC.
servlet.cors.enabled

true

false (Valor predeterminado)

Si esta propiedad se establece en true, el soporte CORS (Cross Original Resource Sharing) en las API REST está habilitado. Todas las demás propiedades de soporte de CORS sólo son aplicables si esta propiedad se establece en true.
servlet.cors.max.age Valores válidos = <número de segundos>

Valor predeterminado = 3600

Determina el intervalo de tiempo (en segundos) durante el cual el navegador almacena en memoria caché los resultados de la solicitud de preparación previa en una memoria caché de resultados de preparación previa. Corresponde a la cabecera de respuesta HTTP , "Access-Control-Max-Age".
servlet.cors.allow.credentials

true (Valor predeterminado)

false

Indica si el navegador puede enviar credenciales al servidor. Corresponde a la cabecera de respuesta HTTP , "Access-Control-Allow-Credentials".
servlet.cors.allow.origin Valores válidos = <valores separados por comas de dominios de host (protocolo://nombrehost: [portno])>

Valor predeterminado = *

Determina la lista de dominios de host permitidos. Corresponde a la cabecera de respuesta HTTP , "Access-Control-Allow-Origin". El número [portno] es opcional. Esta propiedad puede aceptar un único valor de comodín (*) para permitir el acceso a cualquier origen.
Nota: IBM® recomienda no utilizar el valor predeterminado de "*" en el entorno de producción.
servlet.cors.expose.headers Valores válidos = <valores separados por comas de cabeceras HTTP>

No se ha definido el valor predeterminado.

Determina la lista de cabeceras HTTP a las que puede acceder un navegador. Corresponde a la cabecera de respuesta HTTP , "Access-Control-Expose-Headers".
servlet.cors.allow.headers Valores válidos = <valores separados por comas de cabeceras HTTP> Determina la lista de cabeceras HTTP permitidas. Corresponde a la cabecera de respuesta HTTP , "Access-Control-Allow-Headers". El valor de esta propiedad se devuelve en la respuesta a una solicitud previa. De forma predeterminada, el valor de esta propiedad es el mismo que el valor de la cabecera de solicitud entrante, "Access-Control-Request-Headers".
servlet.cors.allow.methods Valores válidos = <valores separados por comas de métodos HTTP> Determina la lista de métodos HTTP permitidos. Corresponde a la cabecera de respuesta HTTP , "Access-Control-Allow-Methods". El valor de esta propiedad se devuelve en la respuesta a una solicitud previa. De forma predeterminada, el valor de esta propiedad es el mismo que el valor de la cabecera de solicitud entrante, "Access-Control-Request-Method".