Befehlsgruppe "STSManagement" für das Objekt "AdminTask"
Sie können die Scripting-Sprachen Jython und Jacl verwenden, um die Sicherheit mit dem Tool "wsadmin" zu konfigurieren. Die Befehle und Parameter in der Gruppe "STSManagement" können verwendet werden, um Tokenproviderkonfigurationen und Endpunktkonfigurationen für den Trust-Service zu verwalten und abzurufen.
Die Befehlsgruppe "STSManagement" enthält Befehle, mit denen Sie vorhandene Tokenprovider konfigurieren, Endpunkten Tokenprovider zuordnen und allgemeine Konfigurationsdaten des Trust-Service ändern können. Die Befehle in dieser Gruppe, die Konfigurationsänderungen vornehmen, erfordern die Ausführung des Befehls "save", um die Änderungen festzuschreiben. Es werden keine Konfigurationsänderungen vorgenommen, wenn bei der Ausführung eines Befehls eine Ausnahme ausgelöst wird.
- createSTSTokenTypeConfiguration
- deleteSTSTokenTypeConfigurationCustomProperties
- listSTSConfiguredTokenTypes
- querySTSDefaultTokenType
- querySTSTokenTypeConfigurationDefaultProperties
- querySTSTokenTypeConfigurationCustomProperties
- setSTSDefaultTokenType
- updateSTSTokenTypeConfiguration
- removeSTSTokenTypeConfiguration
createSTSTokenTypeConfiguration
Der Befehl "createSTSTokenTypeConfiguration" wird verwendet, um eine Tokenproviderkonfiguration zu erstellen.
Zielobjekt
Geben Sie das Objekt "LocalName" an, das als Kennung für verschiedene Konfigurationen verwendet wird. Der Wert des Objekts "LocalName" muss eindeutig sein.
Erforderliche Parameter
- -URI
- Der URI des Tokenproviders. Diese Wert muss unter allen URIs für Konfigurationstokentypen eindeutig sein. (String, erforderlich.)
- -HandlerFactory
- Geben Sie den vollständig qualifizierten Klassennamen der Schnittstelle "org.eclipse.higgins.sts.IObjectFactory" an. (String, erforderlich.)
Optionale Parameter
- -lifetimeMinutes
- Gibt die maximale Lebensdauer eines ausgestellten Tokenproviders an. Der Standardwert ist 120 Minuten. (Integer, optional)
- -distributedCache
- Gibt an, ob der verteilte Cache aktiviert oder inaktiviert werden soll. Geben Sie true an, um den verteilten Cache zu aktivieren. Der Standardwert ist false. Wenn Sie diese Option angeben, generiert der Sicherheitskontexttokenprovider eine Warnung und ändert die Konfiguration des verteilten WS-Security-Caches. Für angepasste Token geben Sie keinen Wert für diesen Parameter an. (Boolean, optional)
- -tokenCacheFactory
- Gibt den vollständig qualifizierten Klassennamen für den Tokenprovider an. Die SecureConversation-Token-Handler-Klasse erkennt diesen Parameter nicht. (String, optional).
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.createSTSTokenTypeConfiguration('myTokenType', '[-HandlerFactory test.ibm.samples.myTokenType -URI http://ibm.com/tokens/schema/myTokenType]')
- Mit Jython (List):
AdminTask.createSTSTokenTypeConfiguration('myTokenType', ['-HandlerFactory', 'test.ibm.samples.myTokenType', '-URI', 'http://ibm.com/tokens/schema/myTokenType'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.createSTSTokenTypeConfiguration('-interactive')
deleteSTSTokenTypeConfigurationCustomProperties
Der Befehl "deleteSTSTokenTypeConfigurationCustomProperties" wird verwendet, um angepasste Eigenschaften aus einer Tokenproviderkonfiguration zu entfernen.
Zielobjekt
Geben Sie das Objekt "LocalName" des gewünschten Tokenproviders an.
Erforderliche Parameter
Ohne
Optionale Parameter
- -propertyNames
- Geben Sie die Namen der angepassten Eigenschaften an, die aus der Konfiguration gelöscht werden sollen. Wenn die angegebenen Eigenschaften nicht in Ihrer Konfiguration enthalten sind, wird eine Fehlernachricht angezeigt. (String[], optional)
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', '[-propertyNames com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig]')
- Mit Jython (List):
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', ['-propertyNames', 'com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('-interactive')
listSTSConfiguredTokenTypes
Der Befehl "listSTSConfiguredTokenTypes" wird verwendet, um die lokalen Namen aller konfigurierten Tokenprovider aufzulisten.
Zielobjekt
Ohne
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt die lokalen Namen aller konfigurierten Tokenprovider zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.listSTSConfiguredTokenTypes()
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTasklistSTSConfiguredTokenTypes('-interactive')
querySTSDefaultTokenType
Der Befehl "querySTSDefaultTokenType" wird verwendet, um den lokalen Namen des Standardtokenproviders zu bestimmen.
Zielobjekt
Ohne
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt den lokalen Namen des Standardtokenproviders zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.querySTSDefaultTokenType()
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.querySTSDefaultTokenType('-interactive')
querySTSTokenTypeConfigurationDefaultProperties
Der Befehl "querySTSTokenTypeConfigurationDefaultProperties" wird verwendet, um nicht angepasste Eigenschaften eines Tokenproviders vom Trust-Service abzurufen.
Zielobjekt
Geben Sie das Objekt "LocalName" des abzufragenden Tokenproviders an.
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine java.util.Properties-Instanz zurück, die die Werte der nicht angepassten Eigenschaften enthält. Zu nicht angepassten Eigenschaften gehören "URI", "HandlerFactory", "lifetimeMinutes", "distributedCache", "postdatable", "renewableAfterExpiration" und "renewalWindowMinutes".
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('TokenType2')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('-interactive')
querySTSTokenTypeConfigurationCustomProperties
Der Befehl querySTSTokenTypeConfigurationCustomProperties wird verwendet, um den Trust-Service abzufragen.
Zielobjekt
Geben Sie das Objekt "LocalName" des gewünschten Tokenproviders an.
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine java.util.Properties-Instanz zurück, die die Werte der angepassten Eigenschaften enthält.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.querySTSTokenTypeConfigurationCustomProperties('TokenType2')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.querySTSTokenTypeConfigurationCustomProperties('-interactive')
setSTSDefaultTokenType
Der Befehl "setSTSDefaultTokenType" wird verwendet, um den Standardtokenprovidcer für den Trust-Service festzulegen.
Zielobjekt
Geben Sie das Objekt "LocalName" des Tokenproviders als Standard an.
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.setSTSDefaultTokenType('TokenType2')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.setSTSDefaultTokenType('-interactive')
updateSTSTokenTypeConfiguration
Der Befehl "updateSTSTokenTypeConfiguration" wird verwendet, um die Konfigurationsdaten für einen Tokenprovider zu aktualisieren. Alle Parameter sind optional. Die angegebenen Parameter werden in der Konfiguration aktualisiert, wenn dasdie Eigenschaft bereits vorhanden ist. Wenn die Eigenschaft nicht vorhanden ist, wird es der Konfiguration hinzugefügt. Zum Entfernen angepasster Eigenschaften verwenden Sie den Befehl deleteSTSTokenTypeConfigurationCustomProperties.
Zielobjekt
Geben Sie das Objekt "LocalName" des gewünschten Tokenproviders an.
Erforderliche Parameter
Ohne
Optionale Parameter
- -URI
- Der URI des Tokenproviders. Diese Wert muss unter allen URIs für Konfigurationstokentypen eindeutig sein. (String, optional)
- -HandlerFactory
- Geben Sie den vollständig qualifizierten Klassennamen einer Implementierung der Schnittstelle "org.eclipse.higgins.sts.utilities.IObjectFactory" an. (String, optional)
- -lifetimeMinutes
- Die maximale Lebensdauer eines ausgestellten Tokenproviders. Der Standardwert ist 120 Minuten. (Integer, optional)
- -distributedCache
- Gibt an, ob der verteilte Cache aktiviert oder inaktiviert werden soll. Geben Sie true an, um den verteilten Cache zu aktivieren. Der Standardwert ist false. Wenn Sie diese Option angeben, generiert der Sicherheitskontexttokenprovider eine Warnung und ändert die Konfiguration des verteilten WS-Security-Caches. Für angepasste Token geben Sie keinen Wert für diesen Parameter an. (Boolean, optional)
- -postdatable
- Setzen Sie diesen Parameter auf true, damit Token dieses Tokenproviders zu einem künftigen Zeitpunkt gültig werden können. Der Standardwert ist "false". (Boolean, optional)
- -renewableAfterExpiration
- Setzen Sie diesen Parameter auf true, damit Token dieses Tokenproviders nach ihrem Verfallsdatum erneuert werden können. Der Standardwert ist false. (Boolean, optional)
- -renewableWindowMinutes
- Geben Sie an, wie viele Minuten nach dem Verfall eines Tokens ein Token dieses Tokenproviders erneuert werden kann. Wenn die angegebene Zeit bereits abgelaufen ist, kann das Token nicht erneuert werden. Der Standardwert ist 120 Minuten. (Integer, optional)
- -tokenCacheFactory
- Gibt den vollständig qualifizierten Klassennamen für den Tokenprovider an. Die SecureConversation-Token-Handler-Klasse erkennt diesen Parameter nicht. (String, optional).
- -customProperties
- Geben Sie alle weiteren angepassten Eigenschaften an. (java.util.Properties, optional).
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', '[-lifetimeMinutes 100 -renewableAfterExpiration false -distributedCache true]')
- Mit Jython (List):
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', ['-lifetimeMinutes', '100', ' -renewableAfterExpiration', 'false', '-distributedCache', 'true'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.updateSTSTokenTypeConfiguration('-interactive')
removeSTSTokenTypeConfiguration
Der Befehl "removeSTSTokenTypeConfiguration" entfernt eine Tokenproviderkonfiguration.
Zielobjekt
Geben Sie das Objekt "LocalName" des gewünschten Tokenproviders an.
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.removeSTSTokenTypeConfiguration('myTokenType')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.removeSTSTokenTypeConfiguration ('-interactive')
assignSTSEndpointTokenType
Der Befehl "assignSTSEndpointTokenType" wird verwendet, um beim Zugriff auf einen bestimmten Endpunkt einen Tokenprovider anzugeben.
Zielobjekt
Geben Sie das Objekt "endpointURI" des Endpunkts an, der dem angegebenen Tokenprovider zugeordnet werden soll. Wenn der angegebene Endpunkt bereits einem Tokenprovider zugeordnet wurde, wird eine Fehlernachricht angezeigt.
Erforderliche Parameter
Ohne
Optionale Parameter
- -LocalName
- Geben Sie den lokalen Namen des Tokenproviders an, der dem angegebenen Endpunkt zugeordnet werden soll. Wenn die Tokenproviderkonfiguration nicht vorhanden ist, wird eine Fehlernachricht angezeigt. Wenn Sie diesen Parameter nicht angeben, wird der Standardtokenprovider verwendet. (String, optional)
- -issuer
- Geben Sie den URI des Aussstellers an, der den auzustellenden Tokenprovider angibt. Dieser Wert darf null sein. (String, optional)
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType1]')
- Mit Jython (List):
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType1'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.assignSTSEndpointTokenType ('-interactive')
listSTSAssignedEndpoints
Der Befehl "listSTSAssignedEndpoints" wird verwendet, um die URIs der zugeordneten Endpunkte aufzulisten.
Zielobjekt
Ohne
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt die URIs aller zugeordneten Endpunkte an.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.listSTSAssignedEndpoints()
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.listSTSAssignedEndpoints ('-interactive')
listSTSEndpointTokenTypes
Der Befehl "listSTSEndpointTokenTypes" wird verwendet, um den einem bestimmen Endpunkt zugeordneten Tokenprovider vom Trust-Service abzurufen.
Zielobjekt
Geben Sie das Objekt "endpointURI" des abzufragenden Endpunkts an. Es wird eine Ausnahme ausgelöst, wenn der angegebene Endpunkt keinem Tokenprovider zugeordnet ist.
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt den lokalen Namen des Tokenproviders zurück, der dem angegebenen Endpunkt zugeordnet ist.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.listSTSEndpointTokenTypes()
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.listSTSEndpointTokenTypes ('-interactive')
unassignSTSEndpointTokenType
Der Befehl "unassignSTSEndpointTokenType" wird verwendet, um die Zuordnung eines Endpunkts zu einem Tokenprovider aufzuheben.
Zielobjekt
Geben Sie das Objekt "endpointURI" des Endpunkts an, dessen Zuordnung zum angegebenen Tokenprovider aufgehoben werden soll. Es wird eine Ausnahme ausgelöst, wenn der angegebene Endpunkt keinem Tokenprovider zugeordnet ist.
Erforderliche Parameter
- -LocalName
- Geben Sie den lokalen Namen der Tokenproviderkonfiguration an, deren Zuordnung zum angegebenen Endpunkt aufgehoben werden soll. (String, erforderlich.)
Optionale Parameter
- -issuer
- Geben Sie den URI des Ausstellers in der Tokenproviderzuordnung an, die entfernt werden soll. (String, optional)
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/','[-LocalName tokenType2]')
- Mit Jython (List):
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.unassignSTSEndpointTokenType ('-interactive')
updateSTSEndpointTokenType
Der Befehl "updateSTSEndpointTokenType" wird verwendet, um einem bestimmten Endpunkt einen anderen Tokenprovider zuzuordnen.
Zielobjekt
Geben Sie das Objekt "endpointURI" des zu aktualisierenden Endpunkts an. Es wird eine Ausnahme ausgelöst, wenn der angegebene Endpunkt keinem Tokenprovider zugeordnet ist.
Erforderliche Parameter
- -LocalName
- Geben Sie den lokalen Namen des Tokenproviders an, der dem angegebenen Endpunkt zugeordnet werden soll. Wenn die Tokenproviderkonfiguration nicht vorhanden ist, wird eine Fehlernachricht angezeigt. Wenn Sie diesen Parameter nicht angeben, wird der Standardtokenprovider verwendet. (String, optional)
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType2]')
- Mit Jython (List):
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.updateSTSEndpointTokenType('-interactive')
addSTSProperty
Der Befehl "addSTSProperty" fügt eine neue Eigenschaft für den Trust-Service hinzu.
Zielobjekt
Geben Sie einen eindeutigen Namen für die neue Eigenschaft an. (String, erforderlich).
Erforderliche Parameter
- -propertyValue
- Gibt den Wert der hinzuzufügenden Eigenschaft an. (String, erforderlich.)
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.addSTSProperty('pluginSCTVersion', '[-propertyValue 2.0]')
- Mit Jython (List):
AdminTask.addSTSProperty('pluginSCTVersion', ['-propertyValue', '2.0'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.addSTSProperty('-interactive')
deleteSTSProperty
Der Befehl "deleteSTSProperty" löscht eine vorhandene Eigenschaft aus dem Tust-Service.
Zielobjekt
Geben Sie den Namen der zu löschenden Eigenschaft an.
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.deleteSTSProperty('pluginSCTVersion')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.deleteSTSProperty('-interactive')
editSTSProperty
Der Befehl "editSTSProperty" ändert eine vorhandene Eigenschaft für den Trust-Service.
Zielobjekt
Geben Sie den Namen der zu ändernden Eigenschaft an. (String, erforderlich)
Erforderliche Parameter
- -propertyValue
- Gibt den neuen Wert für die gewünschte Eigenschaft an. (String, erforderlich.)
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.editSTSProperty('pluginSCTVersion', '[-propertyValue 2.1]')
- Mit Jython (List):
AdminTask.editSTSProperty('pluginSCTVersion', ['-propertyValue', '2.1'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.editSTSProperty('-interactive')
listSTSProperties
Der Befehl "listSTSProperties" listet alle vorhandenen Eigenschaften und ihre Werte für den Trust-Service auf.
Zielobjekt
Ohne
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine "java.util.Properties"-Instanz zurück, die die Namen und Werte der Eigenschaften enthält.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.listSTSProperties()
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.listSTSProperties('-interactive')
refreshSTS
Der Befehl "refreshSTS" aktualisiert die Konfiguration des Trust-Service ohne Neustart des Anwendungsservers.
Zielobjekt
Ohne
Erforderliche Parameter
Ohne
Optionale Parameter
Ohne
Rückgabewerte
Der Befehl gibt eine Erfolgs- oder Fehlernachricht zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython:
AdminTask.refreshSTS()