---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PersonalAuthAPI - スコープ指定

# PersonalAuthAPI - スコープ指定 {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

PersonalAuthAPI には、個人認証情報のアクセストークン/リフレッシュトークンを管理できるメソッドが用意されています。

この API にアクセスするには、個人認証 (com.snc.sn_ihub_personal_auth) プラグインを有効にする必要があります。この API は `sn_cc` 名前空間で実行されます。

この API にアクセスする前に、インスタンスで個人認証を構成する必要があります。詳細については、「[Create a Connection \& Credential alias](https://www.servicenow.com/docs/access?context=connection-alias&version=australia&pubname=australia-platform-security&ft:locale=en-US)」を参照してください。

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

新しい PersonalAuthAPI オブジェクトをインスタンス化します。
{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#PerAuth-PersonalAuthAPI__table_t5w_235_lbc}  
次のコード例は、PersonalAuthAPI オブジェクトをインスタンス化する方法を示しています。

    var personalAuthAPI = new sn_cc.PersonalAuthAPI();

## PersonalAuthAPI:getInitiatorURL(文字列 aliasId) {#ariaid-title3}

指定されたエイリアスに関連付けられた個人認証情報の OAuth イニシエーター URL を返します。
{#PerAuth-getInitiatorURL_S__table_fhk_4bl_3bc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| aliasId | 文字列 | OAuth イニシエーター URL を取得する接続または資格情報エイリアスのSys_id。 テーブル:接続および資格情報エイリアス \[sys_alias\] |
[表 : 2. パラメーター]

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

| タイプ | 説明 |
|-|-|
| 文字列 | 指定されたエイリアスに関連付けられている個人認証情報の OAuth イニシエーター URL。指定されたエイリアスに個人認証情報が存在しない場合、このメソッドは空の文字列を返します。 |
[表 : 3. 返される内容]

{#PerAuth-getInitiatorURL_S__table_ghk_4bl_3bc}  
次のコード例は、このメソッドを呼び出す方法を示しています。

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

出力：

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

## PersonalAuthAPI:isTokenValid(文字列 aliasId) {#ariaid-title4}

指定されたエイリアスに関連付けられた個人認証情報に有効なアクセス/リフレッシュトークンが存在するかどうかを確認します。
{#PerAuth-isTokenValid_S__table_npq_pk2_3bc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| aliasId | 文字列 | 関連付けられた個人認証情報を確認するための接続または認証情報エイリアスのSys_id。 テーブル:接続および資格情報エイリアス \[sys_alias\] |
[表 : 4. パラメーター]

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

| タイプ | 説明 |
|-|-|
| ブーリアン | 指定されたエイリアス ID に関連付けられた個人認証情報があるかどうかを示すフラグ。 可能な値： * true:有効な個人認証情報が存在します。 * false:有効な個人認証情報が存在しません。 |
[表 : 5. 返される内容]

{#PerAuth-isTokenValid_S__table_opq_pk2_3bc}  
次のコード例は、このメソッドを呼び出す方法を示しています。

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

出力：

    true

## PersonalAuthAPI:revokeToken(文字列 aliasId) {#ariaid-title5}

指定されたエイリアスに関連付けられている個人認証情報の既存のアクセス/リフレッシュトークンを取り消します。
{#PerAuth-revokeToken_S__table_nsn_nwk_3bc__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| aliasId | 文字列 | 個人認証情報のアクセス/リフレッシュトークンを取り消す接続または認証情報エイリアスのSys_id。 テーブル:接続および資格情報エイリアス \[sys_alias\] |
[表 : 6. パラメーター]

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

| タイプ | 説明 |
|-|-|
| オブジェクト | 認証情報とメソッド呼び出しのステータスに関する追加情報を取得するために呼び出すことができるメソッドを含むオブジェクト。これらのメソッドは、次回このメソッドが呼び出されるまで使用できます。 * \<object_name\>.getResponseStatus():revokeToken() メソッド呼び出しのステータス (成功または失敗) を返します。エラーに関する追加情報は、エラーログで確認できます。 * \<object_name\>.getExpiryInSeconds(): 関連付けられた認証情報の有効期限が切れるまでの秒数を返します。この値が 0 以外の値の場合、取り消し要求は失敗しています。 * \<object_name\>.isAuthenticated():個人認証トークンが存在するかどうかを示すブール値を返します。revokeToken() メソッドの呼び出しが成功した場合、このメソッドは false を返す必要があります。 * \<object_name\>.getCredentialId():トークンに関連付けられた個人認証情報のsys_idを返します。OAuth 2.0 認証情報 \[oauth_2_0_credentials\] テーブルにあります。 |
[表 : 7. 返される内容]

{#PerAuth-revokeToken_S__table_osn_nwk_3bc}  
次のコード例は、このメソッドを呼び出す方法を示しています。

    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());

出力：

    SUCCESS
    0
    false
    d84b5115532102104c4bddeeff7b12f2