2.2. appspecifictokens
現在のユーザーのアプリケーション固有のトークンを管理します。
2.2.1. listAppTokens
ユーザーのアプリケーション固有のトークンを一覧表示します。
GET /api/v1/user/apptoken
承認: oauth2_implicit(user:admin)
クエリーパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
query |
expiring | true の場合には、まもなく有効期限が切れるトークンのみを返します。 | ブール値 |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.2.2. createAppToken
ユーザー向けに新規アプリケーション固有のトークンを作成します。
POST /api/v1/user/apptoken
承認: oauth2_implicit(user:admin)
要求のボディースキーマ (アプリケーション/json)
新しいトークンの説明。
名前 | 説明 | スキーマ |
---|---|---|
friendlyName | トークンの特定に役立つ分かりやすい名前 | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
201 | 作成成功 | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.2.3. revokeAppToken
ユーザーの特定のアプリケーショントークンを取り消します。
DELETE /api/v1/user/apptoken/{token_uuid}
承認: oauth2_implicit(user:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
token_uuid | アプリケーション固有のトークンの uuid | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
204 | 削除済み | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |
2.2.4. getAppToken
ユーザーの特定のアプリケーショントークンを返します。
GET /api/v1/user/apptoken/{token_uuid}
承認: oauth2_implicit(user:admin)
パスパラメーター
タイプ | 名前 | 説明 | スキーマ |
---|---|---|---|
path |
token_uuid | アプリケーション固有のトークンの uuid | string |
レスポンス
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | 正常な呼び出し | |
400 | 不適切な要求 | |
401 | セッションが必要 | |
403 | 不正アクセス | |
404 | 結果が見つからない |