2.1.4 認証情報の更新
指定した認証情報に含まれるユーザーIDとパスワードの更新を行います。
権限
Admin
APIのバージョン
v1
リクエスト形式
PUT http[s]://host:port/Analytics/version/objects/Credentials/{id}
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。Credential
{ "name":"...", "credentialType":"...", "userId":"...", "password":"...", "passwordNotRequired":"...", "portNumber":"...", "rootPassword":"...", "updatePassword":"...", "updateRootPassword":"...", "ssl":"...", "domainname":"...", "namespace":"...", "community":"...", "snmpVersion":"...", "userName":"...", "authenticationEnabled":"...", "authenticationPassphrase":"...", "updateAuthenticationPassphrase":"...", "authenticationProtocol":"...", "privacyEnabled":"...", "privacyPassphrase":"...", "updatePrivacyPassphrase":"...", "privacyProtocol":"..." }
Credential (Type: Credential)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
認証情報の名称 |
credentialType |
enum |
監視対象への接続に使用するプロトコル。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
userId |
string |
認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合,”username”メンバーの値が設定されます。 |
password |
string |
認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。更新する場合は、updatePasswordにtrueを指定します。 |
passwordNotRequired |
boolean |
認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。 ・true:パスワードは必要ない。 ・false:パスワードが必要である。 |
portNumber |
int |
ポート番号。監視対象への接続に使用するプロトコルが「ssh」,「SMI-S WBEM」,「SNMP」の場合のみ設定されます。 |
rootPassword |
string |
認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。 監視対象への接続に「ssh」を使用する場合のみ有効です。更新する場合は、updateRootPasswordにtrueを指定します。 |
updatePassword |
boolean |
パスワード(password)を変更するかどうか。 ・true:パスワードの変更を行う。 ・false:パスワードの変更を行わない。 省略時はfalseが指定されます。 |
updateRootPassword |
boolean |
rootパスワード(rootPassword)を変更するかどうか。 ・true:パスワードの変更を行う。 ・false:パスワードの変更を行わない。 省略時はfalseが指定されます。 監視対象への接続に「ssh」を使用する場合のみ有効です。 |
ssl |
boolean |
監視対象への接続時にSSL(https)を使用するかどうか。 ・true:SSLを使用する。 ・false:SSLを使用する。 省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。 |
domainname |
string |
ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。 |
namespace |
string |
ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。 |
community |
string |
コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 |
snmpVersion |
enum |
SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
userName |
string |
認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationEnabled |
boolean |
SMTP認証を行うかどうか。 ・true:認証を有効にする。 ・false:認証を無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationPassphrase |
string |
認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updateAuthenticationPassphraseにtrueを指定します。 |
updateAuthenticationPassphrase |
boolean |
認証パスフレーズを変更するかどうか。 ・true:認証パスフレーズの変更を行う。 ・false:認証パスフレーズの変更を行わない。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationProtocol |
enum |
認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
privacyEnabled |
boolean |
プライバシーを有効にするかどうか。 ・true:プライバシーを有効にする。 ・false:プライバシーを無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyPassphrase |
string |
プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updatePrivacyPassphraseにtrueを指定します。 |
updatePrivacyPassphrase |
boolean |
プライバシーのためのパスフレーズを変更するかどうか。 ・true:パスフレーズを変更する。 ・false:パスフレーズを変更しない。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyProtocol |
enum |
プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Credential
{ "instanceID":"...", "name":"...", "credentialType":"...", "userId":"...", "passwordNotRequired":"...", "portNumber":"...", "ssl":"...", "domainname":"...", "namespace":"...", "community":"...", "snmpVersion":"...", "userName":"...", "authenticationEnabled":"...", "authenticationProtocol":"...", "privacyEnabled":"...", "privacyProtocol":"...", "numOfRelatedResources":"..." }
Credential (Type: Credential)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
name |
string |
認証情報の名称 |
credentialType |
enum |
監視対象への接続に使用するプロトコル。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
userId |
string |
認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合,”username”メンバーの値が設定されます。 |
passwordNotRequired |
boolean |
認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。 ・true:パスワードは必要ない。 ・false:パスワードが必要である。 |
portNumber |
int |
ポート番号。監視対象への接続に使用するプロトコルが「ssh」,「SMI-S WBEM」,「SNMP」の場合のみ設定されます。 |
ssl |
boolean |
監視対象への接続時にSSL(https)を使用するかどうか。 ・true:SSLを使用する。 ・false:SSLを使用する。 省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。 |
domainname |
string |
ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。 |
namespace |
string |
ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。 |
community |
string |
コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 |
snmpVersion |
enum |
SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
userName |
string |
認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationEnabled |
boolean |
SMTP認証を行うかどうか。 ・true:認証を有効にする。 ・false:認証を無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationProtocol |
enum |
認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
privacyEnabled |
boolean |
プライバシーを有効にするかどうか。 ・true:プライバシーを有効にする。 ・false:プライバシーを無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyProtocol |
enum |
プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
numOfRelatedResources |
int |
認証情報を用いて発見されたリソースの数。 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
400 |
Bad Request |
リクエストボディ形式不正 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
更新権限がない |
404 |
Not Found |
リソースが存在しない |
409 |
Conflict |
nameが一致するリソースが存在する |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] PUT /Analytics/v1/objects/Credentials/13 HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Content-Type: application/json Accept-Language: ja Content-Length: 256 [Request Body] { "instanceID" : 13, "name" : "WindowsMonitoring", "credentialType" : "WMI", "userId" : "Administrator", "passwordNotRequired" : false, "updatePassword" : true, "password" : "c3lzdGVtOm1hbmFnZXI=", "domainname" : "domain", "numOfRelatedResources" : 0 } [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 08:42:45 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 4afe674fe8a4e569aa824d8786b0ac5b53e4a_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID" : 13, "name" : "WindowsMonitoring", "credentialType" : "WMI", "userId" : "Administrator", "passwordNotRequired" : false, "domainname" : "domain", "numOfRelatedResources" : 0 }