Groupe de commandes STSManagement de l'objet AdminTask
Vous pouvez utiliser les langages de script Jython ou Jacl pour configurer la sécurité à l'aide de l'outil wsadmin. Les commandes et paramètres du groupe STSManagement peuvent être utilisés pour interroger le service d'accréditation sur les configurations de fournisseur de jeton et les configurations de noeud final et pour gérer celles-ci.
Le groupe de commandes STSManagement contient des commandes qui vous permettent de configurer des fournisseurs de jeton existants, d'attribuer des fournisseurs de jeton à des noeuds finaux et de modifier les données de configuration générales du service d'accréditation. Pour valider les modifications apportées par les commandes de ce groupe, vous devez exécuter la commande save. Aucune modification de configuration n'est effectuée si une exception est créée lors de l'exécution d'une commande.
- createSTSTokenTypeConfiguration
- deleteSTSTokenTypeConfigurationCustomProperties
- listSTSConfiguredTokenTypes
- querySTSDefaultTokenType
- querySTSTokenTypeConfigurationDefaultProperties
- querySTSTokenTypeConfigurationCustomProperties
- setSTSDefaultTokenType
- updateSTSTokenTypeConfiguration
- removeSTSTokenTypeConfiguration
createSTSTokenTypeConfiguration
La commande createSTSTokenTypeConfiguration permet de créer une configuration de fournisseur de jeton.
Objet cible
Spécifiez l'objet LocalName, utilisé comme identificateur pour les diverses configurations. La valeur de l'objet LocalName doit être unique.
Paramètres obligatoires.
- -URI
- URI du fournisseur de jeton. Cette valeur doit être unique dans tous les URI de type de jeton de configuration. (Chaîne, obligatoire)
- -HandlerFactory
- Indique le nom de classe complet d'une implémentation de l'interface org.eclipse.higgins.sts.IObjectFactory. (Chaîne, obligatoire)
Paramètres facultatifs
- -lifetimeMinutes
- Spécifie la durée de vie maximale à attribuer à un fournisseur de jeton émis. La valeur par défaut est 120 minutes. (Entier, facultatif).
- -distributedCache
- Indique si la mémoire cache répartie doit être activée ou désactivée. Spécifiez la valeur true pour activer les fonctions de la mémoire cache répartie. La valeur par défaut est false. Si vous spécifiez cette option, le fournisseur de jeton de contexte de sécurité génère un avertissement et modifie la configuration de la mémoire cache répartie WS-Security. Ne spécifiez aucune valeur pour ce paramètre pour les jetons personnalisés. (Booléen, facultatif)
- -tokenCacheFactory
- Indique le nom de classe complet du fournisseur de jeton. La classe de gestionnaire de jeton de conversation sécurisée ne reconnaît pas ce paramètre. (Chaîne, facultatif)
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.createSTSTokenTypeConfiguration('myTokenType', '[-HandlerFactory test.ibm.samples.myTokenType -URI http://ibm.com/tokens/schema/myTokenType]')
- A l'aide de la liste Jython :
AdminTask.createSTSTokenTypeConfiguration('myTokenType', ['-HandlerFactory', 'test.ibm.samples.myTokenType', '-URI', 'http://ibm.com/tokens/schema/myTokenType'])
Syntaxe d'un exemple de mode interactif
- Avec Jython :
AdminTask.createSTSTokenTypeConfiguration('-interactive')
deleteSTSTokenTypeConfigurationCustomProperties
La commande deleteSTSTokenTypeConfigurationCustomProperties sert à supprimer des propriétés personnalisées d'une configuration de jeton de fournisseur.
Objet cible
Indiquez l'objet LocalName du fournisseur de jeton qui vous intéresse.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
- -propertyNames
- Indiquez le nom des propriétés personnalisées à supprimer de la configuration. Si votre configuration ne contient pas l'une des propriétés indiquées, un message d'erreur est émis. (Chaîne[], facultatif)
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', '[-propertyNames com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig]')
- A l'aide de la liste Jython :
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', ['-propertyNames', 'com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('-interactive')
listSTSConfiguredTokenTypes
La commande listSTSConfiguredTokenTypes permet de répertorier les noms locaux de tous les fournisseurs de jeton configurés.
Objet cible
Aucune
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
Cette commande renvoie les noms locaux de tous les fournisseurs de jeton configurés.
Exemple d'utilisation en mode de traitement par lots
- Avec Jython :
AdminTask.listSTSConfiguredTokenTypes()
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTasklistSTSConfiguredTokenTypes('-interactive')
querySTSDefaultTokenType
La commande querySTSDefaultTokenType permet de déterminer le nom local du fournisseur de jeton par défaut.
Objet cible
Aucune
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
Cette commande renvoie le nom local du fournisseur de jeton par défaut.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.querySTSDefaultTokenType()
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.querySTSDefaultTokenType('-interactive')
querySTSTokenTypeConfigurationDefaultProperties
La commande querySTSTokenTypeConfigurationDefaultProperties permet de demander au service d'accréditation les propriétés non personnalisées d'un fournisseur de jeton.
Objet cible
Indiquez l'objet LocalName du fournisseur de jeton à interroger.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie une instance java.util.Properties qui contient les valeurs des propriétés non personnalisées. Les propriétés non personnalisées sont URI, HandlerFactory, lifetimeMinutes, distributedCache, postdatable, renewableAfterExpiration et renewalWindowMinutes.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('TokenType2')
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('-interactive')
querySTSTokenTypeConfigurationCustomProperties
La commande querySTSTokenTypeConfigurationCustomProperties permet d'interroger le service d'accréditation.
Objet cible
Indiquez l'objet LocalName du fournisseur de jeton qui vous intéresse.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie une instance java.util.Properties contenant les valeurs des propriétés personnalisées.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.querySTSTokenTypeConfigurationCustomProperties('TokenType2')
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.querySTSTokenTypeConfigurationCustomProperties('-interactive')
setSTSDefaultTokenType
La commande setSTSDefaultTokenType permet de définir le fournisseur de jeton par défaut pour le service d'accréditation.
Objet cible
Indiquez l'objet LocalName du fournisseur de jeton comme valeur par défaut.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.setSTSDefaultTokenType('TokenType2')
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.setSTSDefaultTokenType('-interactive')
updateSTSTokenTypeConfiguration
La commande updateSTSTokenTypeConfiguration permet de mettre à jour des données de configuration pour un fournisseur de jeton. Tous les paramètres sont facultatifs. Les paramètres spécifiés sont mis à jour dans la configuration si la propriété existe déjà. Si cette propriété n'existe pas, elle s'ajoute dans la configuration. Pour supprimer des propriétés personnalisées, utilisez la commande deleteSTSTokenTypeConfigurationCustomProperties.
Objet cible
Indiquez l'objet LocalName du fournisseur de jeton qui vous intéresse.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
- -URI
- URI du fournisseur de jeton. Cette valeur doit être unique dans tous les URI de type de jeton de configuration. (Chaîne, facultatif)
- -HandlerFactory
- Indique le nom de classe complet d'une implémentation de l'interface org.eclipse.higgins.sts.utilities.IObjectFactory. (Chaîne, facultatif)
- -lifetimeMinutes
- Durée de vie maximale à attribuer à un fournisseur de jeton émis. La valeur par défaut est 120 minutes. (Entier, facultatif).
- -distributedCache
- Indique si la mémoire cache répartie doit être activée ou désactivée. Spécifiez la valeur true pour activer les fonctions de la mémoire cache répartie. La valeur par défaut est false. Si vous spécifiez cette option, le fournisseur de jeton de contexte de sécurité génère un avertissement et modifie la configuration de la mémoire cache répartie WS-Security. Ne spécifiez aucune valeur pour ce paramètre pour les jetons personnalisés. (Booléen, facultatif)
- -postdatable
- Affectez à ce paramètre la valeur true pour que les jetons de ce fournisseur de jeton soient valides ultérieurement. La valeur par défaut est false. (Booléen, facultatif)
- -renewableAfterExpiration
- Affectez à ce paramètre la valeur true pour que les jetons du fournisseur de jeton soient renouvelables après leur expiration. La valeur par défaut est false. (Booléen, facultatif)
- -renewableWindowMinutes
- Indiquez le délai (en minutes) après l'expiration d'un jeton, pendant lequel un jeton de ce fournisseur de jeton peut être renouvelé. Si ce délai indiqué est écoulé après l'expiration, le jeton ne pourra plus être renouvelé. La valeur par défaut est 120 minutes. (Entier, facultatif).
- -tokenCacheFactory
- Indique le nom de classe complet du fournisseur de jeton. La classe de gestionnaire de jeton de conversation sécurisée ne reconnaît pas ce paramètre. (Chaîne, facultatif)
- -customProperties
- Indiquez toutes les autres propriétés personnalisées. (java.util.Properties, facultatif).
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', '[-lifetimeMinutes 100 -renewableAfterExpiration false -distributedCache true]')
- A l'aide de la liste Jython :
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', ['-lifetimeMinutes', '100', ' -renewableAfterExpiration', 'false', '-distributedCache', 'true'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.updateSTSTokenTypeConfiguration('-interactive')
removeSTSTokenTypeConfiguration
La commande removeSTSTokenTypeConfiguration supprime une configuration de fournisseur de jeton.
Objet cible
Indiquez l'objet LocalName du fournisseur de jeton qui vous intéresse.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.removeSTSTokenTypeConfiguration('myTokenType')
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.removeSTSTokenTypeConfiguration ('-interactive')
assignSTSEndpointTokenType
La commande assignSTSEndpointTokenType permet d'affecter un fournisseur de jeton lors de l'accès à un noeud final spécifique.
Objet cible
Indiquez l'objet endpointURI du noeud final auquel affecter un fournisseur de jeton donné. Si un fournisseur de jeton a déjà été affecté au noeud final indiqué, un message d'erreur est émis.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
- -LocalName
- Indiquez le nom local du fournisseur de jeton à affecter au noeud final spécifié. Si la configuration de fournisseur de jeton n'existe pas, un message d'erreur est émis. Si ce paramètre n'est pas spécifié, le fournisseur de jeton par défaut est utilisé. (Chaîne, facultatif)
- -issuer
- Indiquez l'URI de l'émetteur qui spécifie le fournisseur de jeton à émettre. Cette valeur peut être NULL. (Chaîne, facultatif)
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType1]')
- A l'aide de la liste Jython :
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType1'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.assignSTSEndpointTokenType ('-interactive')
listSTSAssignedEndpoints
La commande listSTSAssignedEndpoints permet de répertorier les URI des noeuds finaux affectés.
Objet cible
Aucune
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie les URI de tous les noeuds finaux affectés.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.listSTSAssignedEndpoints()
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.listSTSAssignedEndpoints ('-interactive')
listSTSEndpointTokenTypes
La commande listSTSEndpointTokenTypes permet de demander au service d'accréditation le fournisseur de jeton affecté à un noeud final spécifique.
Objet cible
Indiquez l'objet endpointURI du noeud final à interroger. Une exception est émise si un fournisseur de jeton n'a pas été affecté au noeud final indiqué.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie le nom local du fournisseur de jeton affecté au noeud final indiqué.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.listSTSEndpointTokenTypes()
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.listSTSEndpointTokenTypes ('-interactive')
unassignSTSEndpointTokenType
La commande unassignSTSEndpointTokenType permet de désaffecter un noeud final de son fournisseur de jeton.
Objet cible
Indiquez l'objet endpointURI du noeud final à désaffecter d'un fournisseur de jeton donné. Une exception est émise si un fournisseur de jeton n'a pas été affecté au noeud final indiqué.
Paramètres obligatoires.
- -LocalName
- Indiquez le nom local de la configuration de fournisseur de jeton à désaffecter du noeud final spécifié. (Chaîne, obligatoire)
Paramètres facultatifs
- -issuer
- Indiquez l'URI de l'émetteur dans l'affectation de fournisseur de jeton à supprimer. (Chaîne, facultatif)
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/','[-LocalName tokenType2]')
- A l'aide de la liste Jython :
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.unassignSTSEndpointTokenType ('-interactive')
updateSTSEndpointTokenType
La commande updateSTSEndpointTokenType permet d'affecter un fournisseur de jeton différent à un noeud final spécifié.
Objet cible
Indiquez l'objet endpointURI du noeud final à mettre à jour. Une exception est émise si un fournisseur de jeton n'a pas été affecté au noeud final indiqué.
Paramètres obligatoires.
- -LocalName
- Indiquez le nom local du fournisseur de jeton à affecter au noeud final spécifié. Si la configuration de fournisseur de jeton n'existe pas, un message d'erreur est émis. Si ce paramètre n'est pas spécifié, le fournisseur de jeton par défaut est utilisé. (Chaîne, facultatif)
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType2]')
- A l'aide de la liste Jython :
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.updateSTSEndpointTokenType('-interactive')
addSTSProperty
La commande addSTSProperty ajoute une nouvelle propriété pour le service d'accréditation.
Objet cible
Indiquez un nom unique pour la nouvelle propriété (chaîne, obligatoire).
Paramètres obligatoires.
- -propertyValue
- Indique la valeur de la propriété à ajouter. (Chaîne, obligatoire)
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.addSTSProperty('pluginSCTVersion', '[-propertyValue 2.0]')
- A l'aide de la liste Jython :
AdminTask.addSTSProperty('pluginSCTVersion', ['-propertyValue', '2.0'])
Syntaxe d'un exemple de mode interactif
- Avec Jython :
AdminTask.addSTSProperty('-interactive')
deleteSTSProperty
La commande deleteSTSProperty supprime une propriété existante du service d'accréditation.
Objet cible
Indiquez le nom de la propriété à supprimer.
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.deleteSTSProperty('pluginSCTVersion')
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.deleteSTSProperty('-interactive')
editSTSProperty
La commande editSTSProperty modifie une propriété existante pour le service d'accréditation.
Objet cible
Indiquez le nom de la propriété à modifier. (Chaîne, obligatoire)
Paramètres obligatoires.
- -propertyValue
- Indique la nouvelle valeur de la propriété qui vous intéresse. (Chaîne, obligatoire)
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.editSTSProperty('pluginSCTVersion', '[-propertyValue 2.1]')
- A l'aide de la liste Jython :
AdminTask.editSTSProperty('pluginSCTVersion', ['-propertyValue', '2.1'])
Syntaxe d'un exemple de mode interactif
- Avec Jython :
AdminTask.editSTSProperty('-interactive')
listSTSProperties
La commande listSTSProperties répertorie toutes les propriétés existantes et leurs valeurs correspondantes pour le service d'accréditation.
Objet cible
Aucune
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie une instance java.util.Properties contenant les noms et les valeurs des propriétés.
Exemple d'utilisation en mode de traitement par lots
- En langage Jython :
AdminTask.listSTSProperties()
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.listSTSProperties('-interactive')
refreshSTS
La commande refreshSTS régénère vos modifications de configuration de service d'accréditation sans redémarrer le serveur d'applications.
Objet cible
Aucune
Paramètres obligatoires.
Aucune
Paramètres facultatifs
Aucune
Valeur de retour
La commande renvoie un message de réussite ou d'échec.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de Jython :
AdminTask.refreshSTS()