hosting

GET /v1/sites/{siteId}/wordpress/roles

List the roles a site's WordPress defines.

すべての hosting エンドポイント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/wordpress/roles \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

The roles available on the install — the site's own, including any a plugin added, rather than a hardcoded list of WordPress's five defaults. `role` is the machine value and `name` the install's own label for it; a client renders `name` and sends `role`. `404` for a site with no vendor hosting package. Requires `sites.view`.

パラメータ

名前タイプ必須これがその内容です
siteId (path)UuidはいSite ID (UUIDv7).

返信

名前タイプ必須これがその内容です
dataSiteWordPressRole[]はいThe roles the install defines.

このエンドポイントが返すエラー

401 · 403 · 404 · 429 · 503