Skip to content

Commit

Permalink
Update auth.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MomentoBigFun authored Jan 15, 2025
1 parent ee086cf commit 4f22656
Showing 1 changed file with 18 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
#### Parameters
----------------
- **scope** - [*PermissionScope*](#permissionscope-objects): 新しいトークンに付与するパーミッション。PermissionScopeオブジェクトはSDKによって提供されます。
- **expiresIn** - *Number* \| *ExpiresIn object*: ExpiresIn.never()`メソッド、`ExpiresIn.minutes()`メソッド、`ExpiresIn.hours()`メソッドを呼び出すことで、トークンが期限切れになるまでの秒数、またはその期間を表すExpiresInオブジェクト。
- **expiresIn** - *ExpiresIn object*: ExpiresIn.never()`メソッド、`ExpiresIn.minutes()`メソッド、`ExpiresIn.hours()`メソッドを呼び出すことで、トークンが期限切れになるまでの秒数、またはその期間を表すExpiresInオブジェクト。

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

- **Error**:
- 詳しくは[レスポンスオブジェクト](./response-objects.md)を参照。
Expand All @@ -65,16 +65,16 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";

#### Parameters
----------------
- **refreshToken** - *string*: 元のAPIキーが生成されたときに提供されたリフレッシュ・トークン
- **refreshToken** - *String*: 元のAPIキーが生成されたときに提供されたリフレッシュ・トークン

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

- **Error**:
- 詳しくは[レスポンスオブジェクト](./response-objects.md)を参照
Expand Down Expand Up @@ -107,15 +107,19 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
#### Parameters
----------------
- **scope** - [*DisposableTokenScope*](#disposabletokenscope-objects):新しい使い捨てトークンに付与する権限。SDK は、あらかじめ DisposableTokenScope オブジェクトを用意しています。
- **expiresIn** - *Number* \| *ExpiresIn object*: トークンが失効するまでの秒数、または ExpiresIn.minutes() メソッドや ExpiresIn.hours(1) メソッドを呼び出して期間を表す ExpiresIn オブジェクト。使い捨てトークンは1時間以内に失効しなければなりません。
- **expiresIn** -*ExpiresIn object*: トークンが失効するまでの秒数、または ExpiresIn.minutes() メソッドや ExpiresIn.hours(1) メソッドを呼び出して期間を表す ExpiresIn オブジェクト。使い捨てトークンは1時間以内に失効しなければなりません。

#### Optional Parameters
----------------
- **tokenId** - *String*: どのメッセージがどの使い捨てトークンで発行されたかを識別するための文字列。
#### Returns
----------------
以下のいずれかです:
- **Success**:
- `authToken`: string - 新しい使い捨て認証トークン
- `endpoint`: string - Momento クライアントがリクエストを行う際に使用する HTTP エンドポイント。
- `expiresAt`: Timestamp - トークンの有効期限が切れるタイムスタンプ
- `authToken`- *String*: - 新しい使い捨て認証トークン
- `endpoint`- *String*: - Momento クライアントがリクエストを行う際に使用する HTTP エンドポイント。
- `expiresAt`- *ExpiresAt object*: - トークンの有効期限が切れるタイムスタンプ

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

0 comments on commit 4f22656

Please sign in to comment.