Grupo de mandatos STSManagement para el objeto AdminTask
Puede utilizar los lenguajes de script Jython o Jacl para configurar la seguridad con la herramienta wsadmin. Los mandatos y parámetros del grupo STSManagement se pueden utilizar para gestionar y consultar las configuraciones del proveedor de señales del servicio de confianza y las configuraciones de los puntos finales.
El grupo de mandatos STSManagement contiene mandatos que le permiten configurar los proveedores de señales existentes, asignar proveedores de señales a los puntos finales y modificar los datos de configuración del servicio de confianza general. Los mandatos de este grupo que efectúan cambios en la configuración requieren que ejecute el mandato save para confirmar los cambios. No se efectúan cambios en la configuración si se genera una excepción cuando se ejecuta un mandato.
- createSTSTokenTypeConfiguration
- deleteSTSTokenTypeConfigurationCustomProperties
- listSTSConfiguredTokenTypes
- querySTSDefaultTokenType
- querySTSTokenTypeConfigurationDefaultProperties
- querySTSTokenTypeConfigurationCustomProperties
- setSTSDefaultTokenType
- updateSTSTokenTypeConfiguration
- removeSTSTokenTypeConfiguration
createSTSTokenTypeConfiguration
El mandato createSTSTokenTypeConfiguration se utiliza para crear una configuración de proveedores de señales.
Objeto de destino
Especifique el objeto LocalName, que se utiliza como identificador para varias configuraciones. El valor del objeto LocalName debe ser exclusivo.
Parámetros necesarios
- -URI
- El URI del proveedor de señales. Este valor debe ser exclusivo entre todos los URI de tipo señal de configuración. (String, obligatorio)
- -HandlerFactory
- Proporcione el nombre de la clase totalmente calificada de una implementación de la interfaz org.eclipse.higgins.sts.IObjectFactory. (String, obligatorio)
Parámetros opcionales
- -lifetimeMinutes
- Especifica la duración máxima que asignar a un proveedor de señales emitido. El valor predeterminado es de 120 minutos. (Integer, opcional)
- -distributedCache
- Especifica si habilitar o inhabilitar la memoria caché distribuida. Especifique true para habilitar la posibilidad de memoria caché distribuida. El valor predeterminado es false.Si especifica esta opción, el proveedor de señales de contexto de seguridad genera un aviso y modifica la configuración de memoria caché distribuida de WS-Security. No especifique un valor para este parámetro en las señales personalizadas. (Boolean, opcional)
- -tokenCacheFactory
- Especifica el nombre de clase totalmente calificado del proveedor de señales. La clase del manejador de señales de Secure Conversation no reconoce este parámetro. (String, opcional).
Valor de retorno
El mandato devuelve un mensaje que indica si la operación ha sido correcta o no.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.createSTSTokenTypeConfiguration('myTokenType', '[-HandlerFactory test.ibm.samples.myTokenType -URI http://ibm.com/tokens/schema/myTokenType]')
- Utilizando la lista Jython:
AdminTask.createSTSTokenTypeConfiguration('myTokenType', ['-HandlerFactory', 'test.ibm.samples.myTokenType', '-URI', 'http://ibm.com/tokens/schema/myTokenType'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.createSTSTokenTypeConfiguration('-interactive')
deleteSTSTokenTypeConfigurationCustomProperties
El mandato deleteSTSTokenTypeConfigurationCustomProperties se utiliza para eliminar las propiedades personalizadas de una configuración del proveedor de señales.
Objeto de destino
Especifique el objeto LocalName del proveedor de señales de interés.
Parámetros necesarios
Ninguno
Parámetros opcionales
- -propertyNames
- Especifique los nombres de las propiedades personalizadas que se han de suprimir de la configuración. Si cualquiera de las propiedades especificadas no existe en la configuración, recibirá un mensaje de error. (String[], opcional)
Valor de retorno
El mandato devuelve un mensaje que indica si la operación ha sido correcta o no.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', '[-propertyNames com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig]')
- Utilizando la lista Jython:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', ['-propertyNames', 'com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('-interactive')
listSTSConfiguredTokenTypes
El mandato listSTSConfiguredTokenTypes se utiliza para listar los nombres locales de todos los proveedores de señales configurados.
Objeto de destino
Ninguno
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve los nombres locales de todos los proveedores de señales configurados.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.listSTSConfiguredTokenTypes()
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTasklistSTSConfiguredTokenTypes('-interactive')
querySTSDefaultTokenType
El mandato querySTSDefaultTokenType se utiliza para determinar el nombre local del proveedor de señales predeterminado.
Objeto de destino
Ninguno
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve el nombre local del proveedor de señales predeterminado.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.querySTSDefaultTokenType()
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.querySTSDefaultTokenType('-interactive')
querySTSTokenTypeConfigurationDefaultProperties
El mandato querySTSTokenTypeConfigurationDefaultProperties se utiliza para consultar al servicio de confianza las propiedades no personalizadas de un proveedor de señales.
Objeto de destino
Especifique el objeto LocalName del proveedor de señales que se ha de consultar.
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve una instancia java.util.Properties que contiene los valores de las propiedades no personalizadas. Las propiedades no personalizadas incluyen el URI, HandlerFactory, lifetimeMinutes, distributedCache, postdatable, renewableAfterExpiration y renewalWindowMinutes.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('TokenType2')
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('-interactive')
querySTSTokenTypeConfigurationCustomProperties
El mandato querySTSTokenTypeConfigurationCustomProperties se utiliza para consultar el servicio de confianza.
Objeto de destino
Especifique el objeto LocalName del proveedor de señales de interés.
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve una instancia java.util.Properties que contiene los valores de las propiedades personalizadas.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.querySTSTokenTypeConfigurationCustomProperties('TokenType2')
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.querySTSTokenTypeConfigurationCustomProperties('-interactive')
setSTSDefaultTokenType
El mandato setSTSDefaultTokenType se utiliza para definir el proveedor de señales predeterminado del servicio de confianza.
Objeto de destino
Especifique el objeto LocalName del proveedor de señales, como valor predeterminado.
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.setSTSDefaultTokenType('TokenType2')
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.setSTSDefaultTokenType('-interactive')
updateSTSTokenTypeConfiguration
El mandato updateSTSTokenTypeConfiguration se utiliza para actualizar los datos de configuración de un proveedor de señales. Todos los parámetros son opcionales. Los parámetros especificados se actualizan en la configuración si la propiedad ya existe. Si la propiedad no existe, se añaden a la configuración. Para suprimir las propiedades personalizas, utilice el mandato deleteSTSTokenTypeConfigurationCustomProperties.
Objeto de destino
Especifique el objeto LocalName del proveedor de señales de interés.
Parámetros necesarios
Ninguno
Parámetros opcionales
- -URI
- El URI del proveedor de señales. Este valor debe ser exclusivo entre todos los URI de tipo señal de configuración. (String, opcional)
- -HandlerFactory
- Proporcione el nombre de la clase totalmente calificada de una implementación de la interfaz org.eclipse.higgins.sts.utilities.IObjectFactory. (String, opcional)
- -lifetimeMinutes
- El tiempo de vida máximo que se asigna a un proveedor de señales emitido. El valor predeterminado es de 120 minutos. (Integer, opcional)
- -distributedCache
- Especifica si habilitar o inhabilitar la memoria caché distribuida. Especifique true para habilitar la posibilidad de memoria caché distribuida. El valor predeterminado es false.Si especifica esta opción, el proveedor de señales de contexto de seguridad genera un aviso y modifica la configuración de memoria caché distribuida de WS-Security. No especifique un valor para este parámetro en las señales personalizadas. (Boolean, opcional)
- -postdatable
- Establezca el valor de este parámetro en true para permitir que las señales de este proveedor de señales sean válidas a partir de una hora en el futuro. El valor predeterminado es false. (Boolean, opcional)
- -renewableAfterExpiration
- Establezca el valor de este parámetro en true para permitir que las señales de este proveedor de señales se puedan renovar después de que hayan caducado. El valor predeterminado es false. (Boolean, opcional)
- -renewableWindowMinutes
- Proporcione el número de minutos después de la caducidad de una señal en que se puede renovar una señal de este proveedor de señales. Si este período de tiempo ha transcurrido después de la caducidad, entonces la señal no estará disponible para su renovación. El valor predeterminado es de 120 minutos. (Integer, opcional)
- -tokenCacheFactory
- Especifica el nombre de clase totalmente calificado del proveedor de señales. La clase del manejador de señales de Secure Conversation no reconoce este parámetro. (String, opcional).
- -customProperties
- Proporcione cualquier propiedad personalizada adicional. (java.util.Properties, opcional).
Valor de retorno
El mandato devuelve un mensaje que indica si la operación ha sido correcta o no.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', '[-lifetimeMinutes 100 -renewableAfterExpiration false -distributedCache true]')
- Utilizando la lista Jython:
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', ['-lifetimeMinutes', '100', ' -renewableAfterExpiration', 'false', '-distributedCache', 'true'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.updateSTSTokenTypeConfiguration('-interactive')
removeSTSTokenTypeConfiguration
El mandato removeSTSTokenTypeConfiguration elimina una configuración del proveedor de señales.
Objeto de destino
Especifique el objeto LocalName del proveedor de señales de interés.
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.removeSTSTokenTypeConfiguration('myTokenType')
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.removeSTSTokenTypeConfiguration ('-interactive')
assignSTSEndpointTokenType
El mandato assignSTSEndpointTokenType se utiliza para proporcionar un proveedor de señales cuando se accede a un punto final específico.
Objeto de destino
Especifique el objeto endpointURI del punto final para asignar un proveedor de señales concreto. si ya se ha asignado el punto final especificado a un proveedor de señales, recibirá un mensaje de error.
Parámetros necesarios
Ninguno
Parámetros opcionales
- -LocalName
- Especifique el nombre local del proveedor de señales que se asignará al punto final especificado. Si no existe la configuración del proveedor de señales, recibirá un mensaje de error. Si no se especifica este parámetro, se utiliza el proveedor de señales predeterminado. (String, opcional)
- -issuer
- Especifique el URI del emisor que especifica el proveedor de señales que se ha de emitir. Este valor puede ser nulo. (String, opcional)
Valor de retorno
El mandato devuelve un mensaje que indica si la operación ha sido correcta o no.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType1]')
- Utilizando la lista Jython:
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType1'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.assignSTSEndpointTokenType ('-interactive')
listSTSAssignedEndpoints
El mandato listSTSAssignedEndpoints se utiliza para listar los URI de los puntos finales asignados.
Objeto de destino
Ninguno
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve los URI de todos los puntos finales asignados.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.listSTSAssignedEndpoints()
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.listSTSAssignedEndpoints ('-interactive')
listSTSEndpointTokenTypes
El mandato listSTSEndpointTokenTypes se utiliza para consultar el servicio de confianza para el proveedor de señales asignado a un punto final específico.
Objeto de destino
Especifique el objeto endpointURI del punto final que se ha de consultar. Se genera una excepción si el punto final especificado no se ha asignado a un proveedor de señales.
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve el nombre local del proveedor de señales asignado al punto final específico.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.listSTSEndpointTokenTypes()
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.listSTSEndpointTokenTypes ('-interactive')
unassignSTSEndpointTokenType
El mandato unassignSTSEndpointTokenType se utiliza para anular la asignación de un punto final a un proveedor de señales.
Objeto de destino
Especifique el objeto endpointURI del punto final para desasignar un proveedor de señales concreto. Se genera una excepción si el punto final especificado no se ha asignado a un proveedor de señales.
Parámetros necesarios
- -LocalName
- Especifique el nombre local de la configuración del proveedor de señales que se desasignará del punto final especificado. (String, obligatorio)
Parámetros opcionales
- -issuer
- Especifique el URI del emisor de la asignación del proveedor de señales que se ha de suprimir. (String, opcional)
Valor de retorno
El mandato devuelve un mensaje que indica si la operación ha sido correcta o no.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/','[-LocalName tokenType2]')
- Utilizando la lista Jython:
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.unassignSTSEndpointTokenType ('-interactive')
updateSTSEndpointTokenType
El mandato updateSTSEndpointTokenType se utiliza para asignar un proveedor de señales distinto a un punto final específico.
Objeto de destino
Especifique el objeto endpointURI del punto final que se ha de actualizar. Se genera una excepción si el punto final especificado no se ha asignado a un proveedor de señales.
Parámetros necesarios
- -LocalName
- Especifique el nombre local del proveedor de señales que se asignará al punto final especificado. Si no existe la configuración del proveedor de señales, recibirá un mensaje de error. Si no se especifica este parámetro, se utiliza el proveedor de señales predeterminado. (String, opcional)
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType2]')
- Utilizando la lista Jython:
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.updateSTSEndpointTokenType('-interactive')
addSTSProperty
El mandato addSTSProperty añade una propiedad nueva para el servicio de confianza.
Objeto de destino
Especifique un nombre exclusivo para la nueva propiedad (string, obligatorio).
Parámetros necesarios
- -propertyValue
- Especifica el valor de la propiedad que se ha de añadir. (String, obligatorio)
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.addSTSProperty('pluginSCTVersion', '[-propertyValue 2.0]')
- Utilizando la lista Jython:
AdminTask.addSTSProperty('pluginSCTVersion', ['-propertyValue', '2.0'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.addSTSProperty('-interactive')
deleteSTSProperty
El mandato deleteSTSProperty suprime una propiedad existente del servicio de confianza.
Objeto de destino
Especifique el nombre de la propiedad que se ha de suprimir.
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.deleteSTSProperty('pluginSCTVersion')
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.deleteSTSProperty('-interactive')
editSTSProperty
El mandato editSTSProperty modifica una propiedad existente para el servicio de confianza.
Objeto de destino
Especifique el nombre de la propiedad que se ha de editar. (String, obligatorio)
Parámetros necesarios
- -propertyValue
- Especifica el nuevo valor de la propiedad de interés. (String, obligatorio)
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando la serie Jython:
AdminTask.editSTSProperty('pluginSCTVersion', '[-propertyValue 2.1]')
- Utilizando la lista Jython:
AdminTask.editSTSProperty('pluginSCTVersion', ['-propertyValue', '2.1'])
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.editSTSProperty('-interactive')
listSTSProperties
El mandato listSTSProperties lista todas las propiedades existentes y sus valores correspondientes para el servicio de confianza.
Objeto de destino
Ninguno
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve una instancia de java.util.Properties que contiene los nombres y valores de las propiedades.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.listSTSProperties()
Ejemplo de utilización de la modalidad interactiva
- Utilizando Jython:
AdminTask.listSTSProperties('-interactive')
refreshSTS
El mandato refreshSTS renueva los cambios de la configuración del servicio de confianza sin reiniciar el servidor de aplicaciones.
Objeto de destino
Ninguno
Parámetros necesarios
Ninguno
Parámetros opcionales
Ninguno
Valor de retorno
El mandato devuelve un mensaje que indica si la operación se ha realizado de forma satisfactoria o anómala.
Uso del ejemplo de modalidad de proceso por lotes
- Utilizando Jython:
AdminTask.refreshSTS()