Abrufen eines Tokens - web_services - 23 - 23.1

Spectrum-Webdienste-Handbuch
Product type
Software
Portfolio
Integrate
Product family
Spectrum™ software
Product
Spectrum™ software > Web Services
Version
23.1
ft:locale
de-DE
Product name
Spectrum Technology Platform
ft:title
Spectrum-Webdienste-Handbuch
First publish date
2007
ft:lastEdition
2023-10-25
ft:lastPublication
2023-10-25T07:20:03.279000

Senden Sie eine Anforderung an den TokenManagerService-Webservice auf dem Spectrum Technology Platform-Server, um ein Token abzurufen. Hier können Sie auf die TokenManagerService-WSDL zugreifen:

http://server:port/security/TokenManagerService?wsdl

Senden Sie eine Anforderung an den security-Webservice auf dem Spectrum Technology Platform-Server, um ein Token abzurufen. Hier können Sie auf die security-WADL zugreifen:

http://server:port/security/rest?_wadl

Dieser Webservice verwendet die Standardauthentifizierung. Dementsprechend müssen Sie einen gültigen Spectrum Technology Platform-Benutzernamen und ein gültiges Kennwort in der Anforderung angeben.

Der TokenManagerService-Webdienst kann zwei Arten von Tokens ausstellen.Der security-Webdienst kann zwei Arten von Tokens ausstellen. Es gibt folgende Tokentypen:

  • Sitzungstoken
  • Open-Token

Abrufen eines Sitzungstokens

Ein Sitzungstoken ist an eine Benutzersitzung geknüpft und kann nur von dem Computer verwendet werden, der das Token angefordert hat. Da es an eine Sitzung geknüpft ist, verliert das Token seine Gültigkeit, wenn die Sitzung 30 Minuten lang inaktiv war. Ein Sitzungstoken bildet den sichersten Tokentyp und wird für die Authentifizierung auf Spectrum Technology Platform empfohlen.

Rufen Sie ein Sitzungstoken über die folgende URL ab:

http://server:port/security/rest/token/access/session/ttlInMinutes

Wo:

server
Der Hostname oder die IP-Adresse Ihres Spectrum Technology Platform-Servers.
Port
Der von Spectrum Technology Platform verwendete HTTP-Port. Standardmäßig lautet dieser 8080.
ttlInMinutes
Die Anzahl an Minuten bis zum Ablauf des Tokens. Dies wird auch als die Gültigkeitsdauer des Tokens bezeichnet. Geben Sie „0“ an, wenn der Token keine Ablaufzeit haben soll.

Nachfolgend wird eine Beispielantwort aufgeführt:

{    "access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..ESnq4JNEBbVMKycd139z0w.NFXAskVY0seX",    "session": "09aa1fbb-71j3-43c7-ab8c-d800214283d4",    "username": "admin" }

TokenManagerService verfügt über zwei SOAP-Vorgänge zum Abrufen eines Sitzungstokens.

Vorgang Beschreibung

getAccessExpiringToken

Geben Sie anhand dieses Vorgangs eine Ablaufzeit für das Token an. Nachfolgend wird eine Beispielanforderung aufgeführt:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:tok="http://token.security.common.server.platform.spectrum.precisely.com/">    <soapenv:Header/>    <soapenv:Body>       <tok:getAccessExpiringToken>          <tokenLifeInMinutes>60</tokenLifeInMinutes>       </tok:getAccessExpiringToken>    </soapenv:Body> </soapenv:Envelope>

Das Element <tokenLifeInMinutes> gibt die Anzahl an Minuten bis zum Ablauf des Tokens an. Dies wird auch als die Gültigkeitsdauer des Tokens bezeichnet. In diesem Beispiel läuft das Token nach 60 Minuten ab.

Nachfolgend wird eine Beispielantwort aufgeführt:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns2:getAccessExpiringTokenResponse        xmlns:ns2="http://token.security.common.server.platform.spectrum.precisely.com/">          <return>             <session>ebd7904b-07f6-15c9-82e4-71589131eb01</session>             <token>eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..2pZB3qgpdC96xfOIPg9</token>             <username>simon0897</username>          </return>       </ns2:getAccessExpiringTokenResponse>    </soap:Body> </soap:Envelope>

getAccessSessionToken

Rufen Sie ein Token ohne Ablaufzeit über diesen Vorgang ab. Beachten Sie, dass das Token dennoch seine Gültigkeit verliert, wenn die Sitzung 30 Minuten lang inaktiv ist. Dies gilt auch, wenn das Token nicht abgelaufen ist.

Nachfolgend wird eine Beispielanforderung aufgeführt:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:tok="http://token.security.common.server.platform.spectrum.precisely.com/">    <soapenv:Header/>    <soapenv:Body>       <tok:getAccessSessionToken/>    </soapenv:Body> </soapenv:Envelope>

Nachfolgend wird eine Beispielantwort aufgeführt:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns2:getAccessSessionTokenResponse       xmlns:ns2="http://token.security.common.server.platform.spectrum.precisely.com/">          <return>             <session>65822c9b-362e-2e0e-a02a-a50a1a761323</session>             <token>eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..CEE-C1VjKTha</token>             <username>simon0897</username>          </return>       </ns2:getAccessSessionTokenResponse>    </soap:Body> </soap:Envelope>

Die folgenden Elemente sind in der Antwort enthalten:

access_token
token
Das Sicherheitstoken.
session
Die Sitzungskennung der Sitzung, an die das Token geknüpft ist. Das Token wird nur akzeptiert, wenn die Sitzungskennung in der Anforderung angegeben wird. Wenn Sie mit einer JavaScript-Anwendung arbeiten, müssen Sie den Header withCredentials: true für die Webanforderung einfügen, um sicherzustellen, dass die Sitzungs-ID für alle Anforderungen übergeben wird.
Benutzername
Der für den Abruf des Tokens verwendete Spectrum Technology Platform-Benutzername. Der Benutzername wird lediglich zu Informationszwecken zurückgegeben und ist bei der Verwendung des Tokens nicht erforderlich.

Abrufen eines Open-Tokens

Ein Open-Token ist weder an einen Benutzer noch an einen spezifischen Computer geknüpft. Dieser Tokentyp bietet das geringste Maß an Sicherheit.

Wichtig: Vermeiden Sie, nicht ablaufende Open-Token zu verwenden. Wenn ein Open-Token von einem nicht autorisierten Dritten abgerufen wird, kann es unbegrenzt und über jeden Computer verwendet werden, um auf Ihren Spectrum Technology Platform-Server zuzugreifen.

Rufen Sie ein Open-Token über die folgende URL ab:

http://server:port/security/rest/token/access/ttlInMinutes

Wo:

server
Der Hostname oder die IP-Adresse Ihres Spectrum Technology Platform-Servers.
Port
Der von Spectrum Technology Platform verwendete HTTP-Port. Standardmäßig lautet dieser 8080.
ttlInMinutes
Die Anzahl an Minuten bis zum Ablauf des Tokens. Dies wird auch als die Gültigkeitsdauer des Tokens bezeichnet. Geben Sie „0“ an, wenn der Token keine Ablaufzeit haben soll.

Nachfolgend wird eine Beispielantwort aufgeführt:

{    "access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..fI",    "username": "admin" }

TokenManagerService verfügt über einen SOAP-Vorgang zum Abrufen eines Open-Tokens.

Vorgang Beschreibung

getAccessToken

Rufen Sie ein Open-Token ab, indem Sie diesen Vorgang ausführen. Nachfolgend wird eine Beispielanforderung aufgeführt:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:tok="http://token.security.common.server.platform.spectrum.precisely.com/">    <soapenv:Header/>    <soapenv:Body>       <tok:getAccessToken/>    </soapenv:Body> </soapenv:Envelope>

Nachfolgend wird eine Beispielantwort aufgeführt:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns2:getAccessTokenResponse       xmlns:ns2="http://token.security.common.server.platform.spectrum.precisely.com/">          <return>             <token>eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..f4JwHB4qPs0l</token>             <username>paul1234</username>          </return>       </ns2:getAccessTokenResponse>    </soap:Body> </soap:Envelope>

Die folgenden Elemente sind in der Antwort enthalten:

access_token
token
Das Sicherheitstoken.
Benutzername
Der für den Abruf des Tokens verwendete Spectrum Technology Platform-Benutzername. Der Benutzername wird lediglich zu Informationszwecken zurückgegeben und ist bei der Verwendung des Tokens nicht erforderlich.