next

Account登録

概要

Accountを登録する

必要な権限

auth

制限事項

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

リクエスト

リクエストURL

{CellURL}__ctl/Account

メソッド

POST

リクエストクエリ

クエリ名概要有効値必須備考
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]として扱う
X-Personium-Credentialパスワード文字列×※unitの設定のパスワード制限に従う
デフォルトは以下の通り
文字数：6～32文字
文字種:半角英数字と下記半角記号
-_!$*=^`{|}~.@

リクエストボディ

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

Status

値概要備考
active有効
deactivated無効化そのアカウントに対する認証が必ず失敗する。
管理者が何らかの理由でアカウントを凍結したい場合などに利用することを想定。
passwordChangeRequiredパスワード変更必須そのアカウントに対する認証時、パスワード変更が必須という結果（認証失敗）とパスワード変更のみ利用可能なトークンを返す。
パスワード変更を実行すると、そのアカウントのStatusは自動で「active」に更新される。
初期パスワードの付与やパスワードの初期化などに利用することを想定。

リクエストサンプル

ID/PW認証用アカウント

{
  "Name": "account1"
}

Google認証用アカウント

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

ID/PW認証＋Google認証用アカウント

{
  "Name": "account1","Type":"basic oidc:google"
}

IPアドレス帯を設定

{
  "Name": "account1","IPAddressRange":"192.127.0.2,192.128.0.0/24"
}

レスポンス

ステータスコード

201

レスポンスヘッダ

ヘッダ名概要備考
Content-Type返却されるデータの形式
Location作成したリソースへのURL
DataServiceVersionODataのバージョン
ETagリソースのバージョン情報
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

レスポンスボディ

オブジェクト項目名型備考
ルートdobjectオブジェクト{1}
{1}resultsarrayオブジェクト{2}の配列
{2}__metadataobjectオブジェクト{3}
{3}uristring作成したリソースへのURL
{3}etagstringEtag値
{2}__publishedstring作成日(UNIX時間)
{2}__updatedstring更新日(UNIX時間)
{1}__countstring$inlinecountクエリでの取得結果件数

Account固有レスポンスボディ

オブジェクト項目名型備考
{3}typestringCellCtl.Account
{2}NamestringAccount名
{2}IPAddressRangestringデフォルト：null
{2}Typestringデフォルト:"basic"
{2}Statusstringデフォルト："active"
{2}Cellstringデフォルト：null

エラーメッセージ一覧

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

レスポンスサンプル

ID/PW認証用アカウント

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/__ctl/Account('account1')",
        "etag": "W/\"1-1486462510467\"",
        "type": "CellCtl.Account"
      },
      "Name": "account1",
      "IPAddressRange": null,
      "Status": "active",
      "Type": "basic",
      "Cell": null,
      "__published": "/Date(1486462510467)/",
      "__updated": "/Date(1486462510467)/"
    }
  }
}

Google認証用アカウント

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/__ctl/Account('account1')",
        "etag": "W/\"1-1486462510467\"",
        "type": "CellCtl.Account"
      },
      "Name": "account1",
      "IPAddressRange": null,
      "Status": "active",
      "Type": "oidc:google",
      "Cell": null,
      "__published": "/Date(1486462510467)/",
      "__updated": "/Date(1486462510467)/"
    }
  }
}

ID/PW認証＋Google認証用アカウント

{
  "d": {
    "results": {
      "__metadata": {
        "uri": "https://cell1.unit1.example/__ctl/Account('account1')",
        "etag": "W/\"1-1486462510467\"",
        "type": "CellCtl.Account"
      },
      "Name": "account1",
      "IPAddressRange": null,
      "Status": "active",
      "Type": "basic oidc:google",
      "Cell": null,
      "__published": "/Date(1486462510467)/",
      "__updated": "/Date(1486462510467)/"
    }
  }
}

cURLサンプル

ID/PW認証用アカウント

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

Google認証用アカウント

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

ID/PW認証＋Google認証用アカウント

curl "https://cell1.unit1.example/__ctl/Account" -X POST -i -H \
'X-Personium-Credential:password' -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-H 'Accept: application/json' -d '{"Name":"account1","Type":"basic oidc:google"}'
← Cell公開鍵取得Account取得 →