プロジェクト アクセストークン API

概要

プロジェクトの API Key を利用してそのプロジェクトの JWT を作成できます。

注釈

拡張パックを契約することにより、Sora Cloud 側で JWT を失効させる機能が利用できます

アクセストークン生成

API URL

https://api.sora-cloud.shiguredo.app/projects/create-access-token

アクセストークンを指定できます。

すべての指定はオプションです。

channel_id

オプション

:

string

Sora のチャネル ID を指定します。

チャネル ID は <チャネル名>@<プロジェクト ID> です。 チャネル名には好きな文字列を指定可能です。

role

オプション

:

string

Sora のロール (sendrecv / sendonly / recvonly) を指定します。

max_channel_connections

オプション

:

integer

範囲:

0-5000

組織の最大同時接続数を指定します。この設定は接続単位で影響します。

例えばこの設定が 1 のトークンを利用した接続はチャネルに 1 接続以上存在する場合は接続ができなくなります。

また、この設定が 0 のトークンを利用した場合、必ず接続に失敗します。

not_before

オプション

:

RFC 3339

URL:

JWT nbf

JWT が有効になる日時を指定します。数値ではなく RFC 3339 フォーマットで指定してください。

expiration_time

オプション

:

RFC 3339

URL:

JWT exp

JWT の有効期限を指定します。数値ではなく RFC 3339 フォーマットで指定してください。

jwt_id

オプション

:

string (UUID)

URL:

JWT jti

jwt_id を指定する場合は UUID を指定する必要があります。

jwt_id を指定しなくても自動で UUID を生成し jti Claim を付与して JWT を生成します。

認証拡張を有効にしたプロジェクト

  • すでに登録済みの jwt_id を指定した場合

    • 登録済みの jwt_id を jti Claim に利用します。ただし jwt_id の期限は更新されません。

  • 登録していない jwt_id を指定した場合

    • 新規で登録して、 jti Claim に利用します。

  • jwt_id を指定しない場合

    • jwt_id が自動生成されて 登録されます

実行例

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/create-access-token \
    channel_id=<Channel-ID> \
    -vvv
$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/create-access-token \
    channel_id=<Channel-ID> \
    not_before='2022-10-20T10:00:00+09:00' \
    expiration_time='2023-10-27T10:00:00+09:00' \
    -vvv
$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/create-access-token \
    channel_id=<Channel-ID> \
    max_channel_connections:=10 \
    -vvv

/projects/create-jwt-id

API URL:

https://api.sora-cloud.shiguredo.app/projects/create-jwt-id

重要

この API を利用するには拡張パックを契約している必要があります。

期限付きの JWT ID を生成します。この JWT ID を利用して JWT を生成した場合、 JWT ID にて失効が可能になります。

JWT ID の利用期限は最大 30 日です。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/create-jwt-id \
    -vvv

/projects/revoke-jwt-id

API URL:

https://api.sora-cloud.shiguredo.app/projects/revoke-jwt-id

重要

この API を利用するには拡張パックを契約している必要があります。

指定した JWT ID を失効させます。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/revoke-jwt-id \
    jwt_id=<JWT-ID> \
    -vvv

/projects/restore-jwt-id

API URL:

https://api.sora-cloud.shiguredo.app/projects/restore-jwt-id

重要

この API を利用するには拡張パックを契約している必要があります。

指定した JWT ID 失効から復元させます。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/restore-jwt-id \
    jwt_id=<JWT-ID> \
    -vvv

/projects/list-revoked-jwt-id

API URL:

https://api.sora-cloud.shiguredo.app/projects/list-revoked-jwt-id

重要

この API を利用するには拡張パックを契約している必要があります。

失効させた JWT ID 一覧を取得します。期限が切れた JWT-ID は含まれません。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/list-revoked-jwt-id \
    -vvv
© Copyright 2022, Shiguredo Inc. Created using Sphinx 5.3.0