2.2. appspecifictokens

現在のユーザーのアプリケーション固有のトークンを管理します。

2.2.1. createAppToken

ユーザー向けに新規アプリケーション固有のトークンを作成します。

POST /api/v1/user/apptoken

承認: oauth2_implicit(user:admin)

要求の body スキーマ (application/json)

新しいトークンの説明。

名前説明スキーマ

friendlyName
任意

トークンの特定に役立つ分かりやすい名前

string

レスポンス
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.2.2. listAppTokens

ユーザーのアプリケーション固有のトークンを一覧表示します。

GET /api/v1/user/apptoken

承認: oauth2_implicit(user:admin)

クエリーパラメーター
タイプ名前説明スキーマ

query

expiring
任意

true の場合には、まもなく有効期限が切れるトークンのみを返します。

boolean

応答
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.2.3. getAppToken

ユーザーの特定のアプリケーショントークンを返します。

GET /api/v1/user/apptoken/{token_uuid}

承認: oauth2_implicit(user:admin)

パスパラメーター
タイプ名前説明スキーマ

path

token_uuid
必須

アプリケーション固有のトークンの uuid

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.2.4. revokeAppToken

ユーザーの特定のアプリケーショントークンを取り消します。

DELETE /api/v1/user/apptoken/{token_uuid}

承認: oauth2_implicit(user:admin)

パスパラメーター
タイプ名前説明スキーマ

path

token_uuid
必須

アプリケーション固有のトークンの uuid

string

レスポンス
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError