sidebar_position	title	sidebar_label	description	hide_table_of_contents
2	Auth API reference information	Auth	知っておく必要がある Auth API 呼び出しと、それらを Momento サービスで使用する方法について学びます。	true

import { SdkExampleTabs } from "@site/src/components/SdkExampleTabs"; import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";

Auth API リファレンス

Auth API は、Momento サービスの API キーとトークンを作成および管理します。これらの認証メカニズムは、1つ以上のキャッシュやトピックスへのアクセスを許可するために、1つ以上のパーミッションを持つようにスコープすることができます。

AuthClient Methods

<div class='col col--4' style={{paddingRight: '20px'}}>

    ### GenerateApiKey

    Generates a new Momento auth token with the specified permissions and expiry.

Parameters

    ----------------
    - **scope** - [*PermissionScope*](#permissionscope-objects): 新しいトークンに付与するパーミッション。PermissionScopeオブジェクトはSDKによって提供されます。
    - **expiresIn** - *ExpiresIn object*: ExpiresIn.never()`メソッド、`ExpiresIn.minutes()`メソッド、`ExpiresIn.hours()`メソッドを呼び出すことで、トークンが期限切れになるまでの秒数、またはその期間を表すExpiresInオブジェクト。

Returns

    ----------------
    以下のいずれか:
    - **Success**:
        - `authToken`- *String*:  新しい認証トークン
        - `refreshToken`- *String*: - RefreshApiKey API](#refreshapikey)で使用できるリフレッシュトークンで、トークンの有効期限が切れる前にリフレッシュします
        - `endpoint`- *String*: string - Momento クライアントがリクエストを行う際に使用する HTTP エンドポイント
        - `expiresAt`- *ExpiresAt object*: Timestamp - トークンの有効期限が切れるタイムスタンプ

    - **Error**:
        - See [response objects](./response-objects.md) for specific information.

</div>

<div class='col col--8'>

    <SdkExampleTabs snippetId={'API_GenerateApiKey'} />

</div>

<div class='col col--4' style={{paddingRight: '20px'}}>

    ### RefreshApiKey。

Refreshes an existing, unexpired Momento API key. Produces a new API key with the same permissions and expiry duration as the original API key.

    #### Parameters
    ----------------
    - **refreshToken** - *String*: The refresh token that was provided when the original API key was generated.

    #### Returns
    ----------------
    One of the following:
    - **Success**:
        - `apiKey`- *String*: the new auth token
        - `refreshToken`- *String*: - a refresh token that can be used with the [RefreshApiKey API](#refreshapikey) to refresh a token before it expires
        - `endpoint`- *String*: the HTTP endpoint the Momento client should use when making requests
        - `expiresAt`- *ExpiresAt object*: the timestamp at which the token will expire

    - **Error**:
        - See [response objects](./response-objects.md) for specific information.

</div>

<div class='col col--8'>

    <SdkExampleTabs snippetId={'API_RefreshApiKey'} />

</div>

<div class='col col--4' style={{paddingRight: '20px'}}>

    ### GenerateDisposableToken

    指定した権限と有効期限を持つ、使い捨ての Momento 認証トークンを生成します。
    使い捨てトークンは、通常の Momento 認証トークンとは以下の点で異なります:
      - トークンはコンソールで生成することはできず、プログラムによってのみ生成することができます。generateDisposableToken`APIコールに使用するトークンは、Momentoコンソールから生成したスーパーユーザースコープのトークンでなければなりません。
      - トークンの有効期限は1時間です。
      - リフレッシュはできないので、リフレッシュトークンは付属しません
      - パーミッションは DisposableTokenScope オブジェクトで指定します。

    #### Optional Parameters
    ----------------
    - **tokenId** - *String*: どのメッセージがどの使い捨てトークンで発行されたかを識別するための文字列
    
    #### Parameters
    ----------------
    - **scope** - [*DisposableTokenScope*](#disposabletokenscope-objects): 新しい使い捨てトークンに付与する権限。SDK は、あらかじめ DisposableTokenScope オブジェクトを用意しています。
    - **expiresIn** - *ExpiresIn object*: トークンが失効するまでの秒数、または ExpiresIn.minutes() メソッドや ExpiresIn.hours(1) メソッドを呼び出して期間を表す ExpiresIn オブジェクト。使い捨てトークンは1時間以内に失効しなければなりません。

    #### Returns
    ----------------
    以下のいずれか:
    - **Success**:
        - `authToken`- *String*: 新しい使い捨て認証トークン
        - `endpoint`- *String*: Momento クライアントがリクエストを行う際に使用する HTTP エンドポイント
        - `expiresAt`- *ExpiresAt object*: トークンの有効期限が切れるタイムスタンプ

    - **Error**:
        - 詳しくは[レスポンスオブジェクト](./response-objects.md)を参照。

  </div>

  <div class='col col--8'>

      <SdkExampleTabs snippetId={'API_GenerateDisposableToken'} />

  </div>

PermissionScope objects

PermissionScope

名前	タイプ	説明
permissions	List <Permission>	新しいトークンに付与するパーミッション

PermissionScopeはパーミッションオブジェクトのリストです。このリストには、CachePermission 型または TopicPermission 型のパーミッションを含めることができ、最大10個のパーミッションオブジェクトを含めることができます。パーミッションは Momento データプレーン API (get や set など) へのアクセスのみを許可する。複数のパーミッションオブジェクトを持つ認証トークンが作成された場合、一致するパーミッションがアクセスを許可します。たとえば、1 つのトークンに 2 つのパーミッションオブジェクトを設定した場合、次のようになります：

アカウントのすべてのキャッシュへの ReadWrite アクセスを許可するパーミッションオブジェクト
キャッシュ foo に対する ReadOnly アクセスを許可するパーミッションオブジェクト

この場合でも、トークンはキャッシュ foo に対してデータ操作 API (set、delete、DictionarySetFields など) を使用することができます。

Permission objects

これらのオブジェクトはキャッシュやトピック情報を持つ特定のロールを定義し、PermissionScopeに割り当てられます。

CachePermission

キャッシュのパーミッションを定義する PermissionScope オブジェクトのコンポーネント

名前	タイプ	説明
role	ReadOnly \| ReadWrite \| WriteOnly	パーミッションによって許可されたアクセスのタイプ
cache	`AllCaches` \| `CacheName`	パーミッションは `CacheName` オブジェクトまたは `AllCaches` 組み込みの値を使用して、セレクトキャッシュの名前で制限することができます。

ロールの場合、CacheRole.ReadOnly を使用すると、CacheSelector で定義されたキャッシュ上のすべての読み取りデータプレーン API (get、DictionaryGetField など) にアクセスできるようになります。 CacheRole.ReadWrite を使用すると、CacheSelector で定義されたキャッシュ上のすべての読み取りデータプレーン API および書き込みデータプレーン API にアクセスできるようになります。 CacheRole.WriteOnly を使用すると、CacheSelector で定義されたキャッシュのすべての書き込みデータプレーン API にアクセスできるようになります。 CacheRole.WriteOnly は、SetIf* のような条件付きの書き込みを意味する API や、ListPushBack が新しい長さを返すなど、コレクションの更新状態に関する情報を返す API には使用できません。カスタムロールはサポートされていません。

キャッシュの場合、値は組み込みの AllCaches か、このパーミッションのキャッシュ名を含む文字列となります。

CachePermission オブジェクトの PermissionScope の例

これは、CachePermissions だけで PermissionScope を作成する例です。

const CachePermissions = {
    permissions: [
        {
            role: CacheRole.ReadWrite, // Managed role
            cache: "MyCache" // grants access to a specific cache
        },
        {
            role: CacheRole.ReadOnly, // Managed role
            cache: AllCaches // Built-in value for access to all caches in the account.
        },
    ],
};

TopicPermission

トークンのパーミッションを定義するPermissionScopeオブジェクトのコンポーネント

名前	タイプ	説明
role	SubscribeOnly \| PublishSubscribe \| PublishOnly	パーミッションによって許可されたアクセスのタイプ。
cache	`AllCaches` \| `CacheName`	パーミッションは `CacheName` オブジェクトを使用して選択したキャッシュに制限することも、`AllCaches` 組み込み値を使用してアカウント内のすべてのキャッシュに制限することもできます。
topic	`AllTopics` \| `TopicName`	パーミッションは `TopicName` オブジェクトを使用して選択したトピックに制限することも、 `AllTopics` 組み込み値を使用して上記のキャッシュ内のすべてのトピックに制限することもできます。

ロールには、TopicRole.PublishSubscribe、TopicRole.SubscribeOnly、TopicRole.PublishOnlyの3つの管理ロールがあります。カスタムロールはサポートされていません。SubscribeOnlyロールを使用するとトピックの購読のみが可能になり、PublishSubscribeロールを使用するとトピックの発行と購読が可能になり、PublishOnlyロールを使用するとトピックの発行のみが可能になります。

キャッシュでは、そのキャッシュの名前空間内のトピックのみがパーミッションによって許可されます。これは組み込みの AllCaches 値またはキャッシュを指定する文字列に設定することができます。

トピックには、組み込みの AllTopics 値を設定することができます。これは、cache で定義されているキャッシュ内のすべてのトピックにアクセスできるようにするもので、特定のトピック名を文字列で指定することもできます。

TopicPermissionオブジェクトのTokenScopeの例

これは、TopicPermissions だけで PermissionScope を作成する例です。

const TopicsPermissions = {
    permissions: [
      {
        role: TopicRole.PublishSubscribe, // Managed role
        cache: 'the-great-wall', // grants access to a specific cache
        topic: 'highlights', // grants access to a specific topic
      },
      {
        role: TopicRole.SubscribeOnly, // Managed role
        cache: AllCaches, // This is a built-in value for access to all caches in the account
        topic: AllTopics, // This is a built-in value for access to all topic in the listed cache(s).
      },
    ],
};

DisposableTokenScope objects

名前	タイプ	説明
permissions	List <DisposableTokenCachePermission \| Permission>	新しいトークンに付与するパーミッション

DisposableTokenScope オブジェクトは、CachePermission、TopicPermission、または DisposableTokenCachePermission タイプのパーミッション・オブジェクトを受け入れます。

DisposableTokenCachePermissions

DisposableTokenCachePermission は CachePermission を拡張したもので、CachePermission と同じフィールドを持ちますが、item フィールドが追加されています。

例えば、キーまたはキープレフィックスを表す文字列に item を設定すると、特定のキーまたはプレフィックスで始まるキーのセットのみにアクセスを制限できます。別の方法として、item を AllCacheItems に設定すると、通常の CachePermission と同じパーミッションのセットが作成されます。

名前	タイプ	説明
role	ReadOnly \| ReadWrite \| WriteOnly	パーミッションによって許可されるアクセスのタイプ
cache	`AllCaches` \| `CacheName`	パーミッションは `CacheName` オブジェクトまたは `AllCaches` 組み込みの値を使用して、セレクトキャッシュの名前で制限することができます。
item	`AllCacheItems` \| `Key` \| `KeyPrefix`	パーミッションは、`Key` または `KeyPrefix` オブジェクト、あるいは `AllCachesItems` 組み込みの値を使用して、名前によるキャッシュアイテムの選択を制限することができます。

キャッシュの場合、値は組み込みの AllCaches か、このパーミッションのキャッシュ名を含む文字列となります。

item の場合、値は組み込みの AllCacheItems か、このパーミッションが対象とするキャッシュアイテムのキーまたはキープレフィックスを含む文字列となります。

DisposableTokenScope オブジェクトの例

これは、3 種類のパーミッション・オブジェクトをすべて持つ DisposableTokenScope を作成する例です： CachePermission、TopicPermission、DisposableTokenCachePermission です。

const exampleDisposableTokenPermission: DisposableTokenCachePermission = {
  role: CacheRole.WriteOnly,
  cache: "WriteCache",
  item: {
    keyPrefix: "WriteKey"
  }
};

const exampleCachePermission: CachePermission = {
  role: CacheRole.ReadOnly,
  cache: "ReadCache"
};

const exampleTopicPermission: TopicPermission = {
  role: TopicRole.PublishSubscribe,
  cache: "ReadWriteCache",
  topic: "MyTopic"
}

const exampleScope: DisposableTokenScope = {
    permissions: [
      exampleDisposableTokenPermission,
      exampleCachePermission,
      exampleTopicPermission,
    ],
};

// Then pass in the entire DisposableTokenScope object when
// you call generateDisposableToken
const tokenResponse = await authClient.generateDisposableToken(
  exampleScope,
  ExpiresIn.minutes(30)
);

FAQ

キャッシュやトピックのパーミッションにカスタムロールを作成できますか?

各権限について、上記の管理された役割のみをサポートしています。

これらのトークンは、MomentoのコントロールプレーンAPIへのアクセスを制御しますか？

GenerateApiKeyAPIで生成されたアクセストークンは、MomentoのデータプレーンAPIへのアクセスのみを制御します。Momento のコントロールプレーン API にアクセスするためのトークンは、Momento console を使用して生成する必要があります。

:::tip

ここで答えられない質問があれば、私たちのDiscordサーバーに飛び、サポートチャンネルで私たちに質問してください。

:::

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auth API リファレンス

AuthClient Methods

Parameters

Returns

PermissionScope objects

PermissionScope

Permission objects

CachePermission

CachePermission オブジェクトの PermissionScope の例

TopicPermission

TopicPermissionオブジェクトのTokenScopeの例

DisposableTokenScope objects

DisposableTokenCachePermissions

DisposableTokenScope オブジェクトの例

FAQ

FilesExpand file tree

auth.md

Latest commit

History

auth.md

File metadata and controls

Auth API リファレンス

AuthClient Methods

Parameters

Returns

PermissionScope objects

PermissionScope

Permission objects

CachePermission

CachePermission オブジェクトの PermissionScope の例

TopicPermission

TopicPermissionオブジェクトのTokenScopeの例

DisposableTokenScope objects

DisposableTokenCachePermissions

DisposableTokenScope オブジェクトの例

FAQ