hosting
POST /v1/sites/{siteId}/wordpress/users
Create an account on a site's WordPress.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/wordpress/users \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "login": <string>, "email": <string>, "display_name": <string>, "password": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Adds a WordPress account. **The caller chooses the password** and it travels in the request only: it is never echoed in the response, never written to our records and never logged. `login` and `email` are checked against WordPress's own rules here, so the customer gets our sentence about a field they can see rather than WordPress's about one they cannot. Refused `422` when the package type does not carry `wp_users`, or when WordPress is not installed. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
login | string | はい | The account's login name. WordPress caps `user_login` at 60 characters and rejects anything outside this character set, so both are enforced here rather than surfaced as a vendo… |
email | string | はい | The account's email address. |
display_name | string | はい | The name shown on the site's posts and comments. |
password | string | はい | The account's password. Write-only: it is accepted here and appears in no response, no log line and no error body. |
role | string | いいえ | The role to create the account in — any role `listSiteWordPressRoles` reports for this install. Omit it (or send `""`) for the platform's default, which is what a vendor with no… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | The account's WordPress id, carried as a string because it is the vendor's identifier rather than ours. |
login | string | はい | The name the account signs in with. |
display_name | string | はい | The name shown on the site's posts and comments. |
email | string | はい | The account's email address. Personal data about the customer's **own** users, which is why the whole listing is gated on `sites.panel_access`. |
roles | string | はい | The account's roles, in the vendor's own spelling. |
registered_at | string | はい | When WordPress recorded the account, in the vendor's own format. Not typed as a date-time: the platform does not guarantee one, and coercing it would invent precision. |
is_administrator | boolean | はい | Whether the account is an administrator. ⛔ Set from **which vendor endpoint the row came from**, not guessed from the role string — the two lists sit behind two different capabi… |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503