リソースグループ更新

Prev Next
Patch
/api/resource_groups/{resource_group_id}

リソースグループを更新します。

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。

Path parameters
resource_group_id
integer (int64) Required

リソースグループID

Body parameters
Expand All
object
name
string Required

リソースグループ名

Exampleサンプルリソースグループ
description
string

リソースグループの説明

Exampleこれはサンプルリソースグループの説明です。
teams
Array of object

チーム。
teamsの値によって、リソースグループに紐づくチームは洗い替えされます。
チームのロールをリソースグループから削除したくない場合は、既存チームidをteamsに含めてください。

Min items0
object
team_id
integer (int64)

チームID

Example1
role
string

ロールです。

Valid values[ "administrator", "editor", "operator", "viewer" ]
Exampleadministrator
Responses
200

更新したリソースグループの詳細を返します。

Expand All
object
id
integer (int64)

リソースグループIDです。

Example1
name
string

リソースグループ名です。

Exampleresource group
description
string | null

メモです。

Exampledescription
teams
Array of object

チームです。

Min items0
object
team_id
integer (int64)

チームIDです。

Example1
role
string

ロールです。

Valid values[ "administrator", "editor", "operator", "viewer" ]
Exampleadministrator
created_at
string

リソースグループの作成日時です。

Example2023-08-23T03:00:00.000+09:00
updated_at
string

リソースグループの更新日時です。

Example2023-08-23T03:00:00.000+09:00
400

リソースグループ管理者が0人でリクエストしているなど、不正なリクエストです。

401

リソースグループ更新権限がないか、API KEYが不正です。

404

指定したリソースグループが存在しません。