ワークスペースリソースを共有

ワークスペースリソースに対するロール('admin'、'editor'、'commenter'、または'viewer'のいずれか)を、ユーザー、グループ、またはワークスペース(サービスアカウント)のAPIキーに付与します。これにより、対象がそのリソースに対してすでに持つロールは上書きされます。ユーザーまたはサービスアカウントを対象にするには、ユーザーのメールアドレスのみを指定します。ユーザーはワークスペース内に存在する必要があります。グループを対象にするには、グループIDのみを指定します。ワークスペース(サービスアカウント)のAPIキーを対象にするには、APIキーIDを指定します。リソースは、そのキーに関連付けられたサービスアカウントと共有されます。共有するには、リソースに対する管理者アクセス権が必要です。

パスパラメータ

resource_idstring必須

対象リソースのID。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
roleenum必須

対象に付与するロール:「admin」、「editor」、「commenter」、「viewer」のいずれか。

許可された値:
resource_typeenum必須

対象リソースのリソースタイプ。

user_emailstring or nullオプション

ユーザーまたはサービスアカウントのメールアドレス。

group_idstring or nullオプション

対象グループのID。‘default’を使用すると、リソースのベースラインロールを設定します。直接のユーザー権限付与、グループメンバーシップ、またはワークスペース(サービスアカウント)APIキーによってより高いロールを持つ場合を除き、すべてのワークスペースメンバーにこのロールが付与されます。

workspace_api_key_idstring or nullオプション

対象ワークスペース(サービスアカウント)APIキーのID。認証のためにヘッダーで渡すAPIキー文字列そのものではなく、キーのIDです。ワークスペース管理者は、Developers → Service Accountsで確認できます。

レスポンス

成功レスポンス。

エラー

422
Unprocessable Entity Error