---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PersonalAuthAPI -- Umfang

# PersonalAuthAPI -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die PersonalAuthAPI Stellt Methoden bereit, mit denen Sie Zugriffs-/Aktualisierungstoken für Anmeldeinformationen zur persönlichen Authentifizierung verwalten können.

Für den Zugriff auf diese API muss das Plugin „persönliche Authentifizierung" (com.snc.sn_ihub_personal_auth) aktiviert sein. Diese API wird in ausgeführt `sn_CC `Namespace.

Vor dem Zugriff auf diese API muss die persönliche Authentifizierung in Ihrer Instanz konfiguriert werden. Weitere Informationen finden Sie unter [Create a Connection \& Credential alias](https://www.servicenow.com/docs/access?context=connection-alias&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).

## PersonalAuthAPI: PersonalAuthAPI() {#ariaid-title2}

Instanziiert ein neues PersonalAuthAPI-Objekt.
{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc}  
Das folgende Codebeispiel zeigt, wie ein PersonalAuthAPI-Objekt instanziiert wird.

    var personalAuthAPI = new sn_cc.PersonalAuthAPI();

## PersonalAuthAPI -- getInitiatorURL (Zeichenfolge aliasId) {#ariaid-title3}

Gibt die OAuth-Initiator-URL für die Anmeldeinformationen für die persönliche Authentifizierung zurück, die einem angegebenen Alias zugeordnet sind.
{#PerAuth-getInitiatorURL_S__table_fhk_4bl_3bc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| aliasId | Zeichenfolge | SYS_ID des Verbindungs- oder Anmeldeinformationsalias, dessen OAuth-Initiator-URL Sie abrufen möchten. Tabelle: Aliasse für Verbindungen und Anmeldeinformationen \[sys_alias\] |
[Tabelle : 2. Parameter]

{#PerAuth-getInitiatorURL_S__table_fhk_4bl_3bc} {#PerAuth-getInitiatorURL_S__table_ghk_4bl_3bc__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | OAuth-Initiator-URL für die Anmeldeinformationen für die persönliche Authentifizierung, die dem angegebenen Alias zugeordnet sind. Wenn die Anmeldeinformationen für die persönliche Authentifizierung für den angegebenen Alias nicht vorhanden sind, gibt die Methode eine leere Zeichenfolge zurück. |
[Tabelle : 3. Rückgaben]

{#PerAuth-getInitiatorURL_S__table_ghk_4bl_3bc}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
    var personalAuthAPI = new sn_cc.PersonalAuthAPI();
    var result = personalAuthAPI.getInitiatorURL(aliasId);
    gs.info(result);

Ausgabe:

    /oauth_initiator.do?oauth_requestor_context=oauth_2_0_credentials&oauth_requestor=d84b5115532102104c4bddeeff7b12f2&oauth_provider_profile=d84b5115532102104c4bddeeff7b12ec&response_type=code&personal=true 

## PersonalAuthAPI -- isTokenValid(Zeichenfolge aliasId) {#ariaid-title4}

Überprüft, ob ein gültiges Zugriffs-/Aktualisierungstoken für die Anmeldeinformationen für die persönliche Autorisierung vorhanden ist, die einem angegebenen Alias zugeordnet sind.
{#PerAuth-isTokenValid_S__table_npq_pk2_3bc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| aliasId | Zeichenfolge | SYS_ID des Verbindungs- oder Anmeldeinformationsalias, um nach den zugehörigen persönlichen Autorisierungsanmeldeinformationen zu suchen. Tabelle: Aliasse für Verbindungen und Anmeldeinformationen \[sys_alias\] |
[Tabelle : 4. Parameter]

{#PerAuth-isTokenValid_S__table_npq_pk2_3bc} {#PerAuth-isTokenValid_S__table_opq_pk2_3bc__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob für die angegebene Alias-ID eine persönliche Autorisierungsanmeldeinformation zugeordnet ist. Mögliche Werte: * Wahr: Gültige Anmeldeinformationen zur persönlichen Autorisierung sind vorhanden. * Falsch: Es sind keine gültigen Anmeldeinformationen zur persönlichen Autorisierung vorhanden. |
[Tabelle : 5. Rückgaben]

{#PerAuth-isTokenValid_S__table_opq_pk2_3bc}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250"; 
    var personalAuthAPI = new sn_cc.PersonalAuthAPI();  
    var result = personalAuthAPI.isTokenValid(aliasId); 
    gs.info(result);

Ausgabe:

    true

## PersonalAuthAPI -- revokeToken(Zeichenfolge aliasId) {#ariaid-title5}

Widerruft ein vorhandenes Zugriffs-/Aktualisierungstoken für die Anmeldeinformationen für die persönliche Authentifizierung, die einem angegebenen Alias zugeordnet sind.
{#PerAuth-revokeToken_S__table_nsn_nwk_3bc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| aliasId | Zeichenfolge | SYS_ID des Verbindungs- oder Anmeldeinformationsalias, dessen Zugriffs-/Aktualisierungstoken für die persönlichen Autorisierungsanmeldeinformationen Sie widerrufen möchten. Tabelle: Aliasse für Verbindungen und Anmeldeinformationen \[sys_alias\] |
[Tabelle : 6. Parameter]

{#PerAuth-revokeToken_S__table_nsn_nwk_3bc} {#PerAuth-revokeToken_S__table_osn_nwk_3bc__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Objekt, das Methoden enthält, die Sie aufrufen können, um zusätzliche Informationen zum Status des Anmeldeinformations- und Methodenaufrufs zu erhalten. Diese Methoden sind bis zum nächsten Aufruf dieser Methode verfügbar. * \<object_name\>.getResponseStatus() : Gibt den Status von zurück WiderrufenToken() Methodenaufruf, entweder Erfolg Oder Fehlgeschlagen . Zusätzliche Informationen zu Fehlern finden Sie in den Fehlerprotokollen. * \<object_name\>.getExpiryInSeconds(): Gibt die Anzahl der Sekunden zurück, bis die zugehörigen Anmeldeinformationen ablaufen. Wenn dieser Wert etwas anderes als Null ist, ist die Widerrufanforderung fehlgeschlagen. * \<object_name\>.isAuthenticated() : Gibt einen booleschen Wert zurück, der angibt, ob das persönliche Authentifizierungstoken vorhanden ist. Wenn WiderrufenToken() Methodenaufruf war erfolgreich, diese Methode muss zurückgeben Falsch . * \<object_name\>.getCredentialId() : Gibt die sys_ID der persönlichen Autorisierungsanmeldeinformationen zurück, die dem Token zugeordnet sind. Befindet sich in der Tabelle „OAuth 2,0-Anmeldeinformationen" \[oauth_2_0_credentials\]. |
[Tabelle : 7. Rückgaben]

{#PerAuth-revokeToken_S__table_osn_nwk_3bc}  
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    var aliasId = "e41b9dd1532102104c4bddeeff7b1250";
    var personalAuthAPI = new sn_cc.PersonalAuthAPI();
    var personalAuthResponse = personalAuthAPI.revokeToken(aliasId); 
    gs.info(personalAuthResponse.getResponseStatus());
    gs.info(personalAuthResponse.getExpiryInSeconds());
    gs.info(personalAuthResponse.isAuthenticated());
    gs.info(personalAuthResponse.getCredentialId());

Ausgabe:

    SUCCESS
    0
    false
    d84b5115532102104c4bddeeff7b12f2


