ユーザー名とパスワード API での認証
この API を使用し、有効なユーザー名とパスワードを使用して、Control Room へのアクセスを認証します。正常にレスポンスを完了した場合は、JSON Web トークンが生成されます。デフォルトでは、トークンは 20 分間有効です。トークンを生成するには、Control Room に対して有効なユーザー名とパスワードが必要です。
リクエスト
POST http://{{localhost}}/v1/authenticationリクエスト本文:
{
"username":"jdoe",
"password":"mypassword@123"
}マルチログイン トークンを生成するためのリクエスト本文:
{
"username":"jdoe",
"password":"mypassword@123",
"multipleLogin":true
}リクエスト パラメーター
| パラメーター | タイプ | 説明 |
|---|---|---|
| ユーザー名 | 文字列 | ユーザー名を入力します。 |
| パスワード | 文字列 | パスワードを入力します。 |
| multipleLogin | Boolean | マルチログインを許可または禁止します。マルチログインの詳細については、「マルチログイン ユーザー」を参照してください。
注: この値が true に設定されている場合、複数の API セッションが許可されます。 |
レスポンス
{
"token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
"user":{
"id":9,
"email":"a@a.com",
"username":"jdoe",
"domain":null,
"firstName":"j",
"lastName":"doe",
"version":9,
"principalId":9,
"deleted":false,
"roles":[
{
"name":"API_Key_Generation",
"id":23,
"version":0
},
{
"name":"AAE_Basic",
"id":2,
"version":0
},
{
"name":"Docrole1",
"id":18,
"version":0
}
],
"sysAssignedRoles":[
],
"groupNames":[
],
"permissions":[
". . ."
],
"licenseFeatures":[
"RUNTIME"
],
"emailVerified":true,
"passwordSet":true,
"questionsSet":true,
"enableAutoLogin":false,
"disabled":false,
"clientRegistered":false,
"description":"",
"createdBy":1,
"createdOn":"2022-03-10T13:39:56-05:00",
"updatedBy":1,
"updatedOn":"2022-03-13T02:09:38-05:00",
"publicKey":null,
"appType":null,
"routingName":null,
"appUrl":null
}
}レスポンス パラメーター
| パラメーター | タイプ | 説明 |
|---|---|---|
| トークン | 文字列 | 生成されたアクセス トークン。アプリケーションがリクエストを行う際に使用するセッション ID として機能します。このトークンはユーザー資格情報と同等であり、保護される必要があります。 注: multipleLogin が true に設定されている場合、子のトークンを複数の API セッションに使用できます。 |
| ユーザー | オブジェクト | ユーザーのすべての詳細情報を含む、返されたユーザー オブジェクト。
|
後続の API リクエストのリクエスト ヘッダーにトークンを挿入します。
注: Cloud に導入され、SAML 認証が有効になっている Control Room の場合は、
username と apikey を使用して Web トークンを生成します。