next

Account更新

概要

既存のAccount情報を更新する

必要な権限

auth

制限事項

  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
  • $formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない

リクエスト

リクエストURL

{CellURL}__ctl/Account(Name='{AccountName}')

または、

{CellURL}__ctl/Account('{AccountName}')

メソッド

PUT

リクエストクエリ

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う
If-Match対象ETag値を指定するETag値×省略時は[*]として扱う
X-Personium-Credentialパスワード文字列×※unitの設定のパスワード制限に従う
デフォルトは以下の通り
文字数：6～32文字
文字種:半角英数字と下記半角記号
-_!$*=^`{|}~.@

リクエストボディ

ヘッダ名概要有効値必須備考
Nameアカウント名桁数：1～128
文字種:半角英数字と右記半角記号（-_!$*=^`{|}~.@）
ただし、先頭文字に半角記号は指定不可		○
Typeアカウントタイプbasic(ID/PWによる認証)
oidc:google(Google OpenID Connectによる認証)
または上記２つをスペースで区切る
説明：省略した場合basicで更新される		×デフォルト：basic
IPAddressRangeIPアドレス帯認証を許可するIPアドレス帯を指定する
カンマ区切りで複数指定、プレフィックス表記による範囲指定可
nullの場合は全てのIPアドレスで認証可とする
説明：省略した場合nullで更新される		×デフォルト：null
Statusステータスアカウントの状態を指定する
Account登録の「Status」を参照
説明：省略した場合activeで更新される		×デフォルト：active

リクエストサンプル

アカウント名更新

{
  "Name": "account2"
}

アカウント名+アカウントタイプ更新

{
  "Name": "account2","Type":"oidc:google"
}

レスポンス

ステータスコード

204

レスポンスヘッダ

なし

レスポンスボディ

なし

エラーメッセージ一覧

エラーメッセージ一覧を参照

cURLサンプル

アカウント名更新

curl "https://cell1.unit1.example/__ctl/Account('account1')" -X PUT -i -H \
'If-Match: *' -H 'X-Personium-Credential:password' -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H \
'Accept: application/json' -d '{"Name":"account2"}'

アカウント名+アカウントタイプ更新

curl "https://cell1.unit1.example/__ctl/Account('account1')" -X PUT -i \
-H 'If-Match: *' -H 'X-Personium-Credential:password' \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-H 'Accept: application/json' -d '{"Name":"account2","Type":"oidc:google"}'

アカウント名+ステータス更新

curl "https://cell1.unit1.example/__ctl/Account('account1')" -X PUT -i -H \
'If-Match: *' -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H \
'Accept: application/json' -d '{"Name":"account2","Status":"deactivated"}'

パスワードの初期化（変更を強制）

curl "https://cell1.unit1.example/__ctl/Account('account1')" -X PUT -i -H \
'If-Match: *' -H 'X-Personium-Credential:Initial_password' -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H \
'Accept: application/json' -d '{"Name":"target_account","Status":"passwordChangeRequired"}'
← Account一覧取得Account部分更新 →