Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
組織とチーム
/
組織

1 つの組織を更新

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

1 件のプロジェクトの名前を変更します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

Resource

PATCH /orgs/{ORG-ID}

リクエスト パス パラメーター

名前
タイプ
説明
ORG-ID
string
組織の一意の識別子。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
status
HTTPレスポンス コード
content
期待される応答本体
false

リクエスト ボディ パラメータ

名前
タイプ
必要性
説明
name
string
必須
組織の新しい名前。

応答

名前
タイプ
説明
id
組織の一意の識別子です。
isDeleted
ブール値
組織が削除されたかどうかを示すフラグ。
links
ドキュメント配列
サブリソースや関連リソースへの 1 つ以上のリンク。 URL の関係は、 Web リンク仕様 で説明されています 。
name
string
新しい組織名。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}?pretty=true" \
     --data '
     {
       "name" :  "Organization Name 1"
     }'

応答例

1{
2  "id": "{ORG-ID}",
3  "isDeleted": false,
4  "links": [{
5      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
6      "rel": "self"
7    },
8    {
9      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups",
10      "rel": "http://mms.mongodb.com/groups"
11    },
12    {
13      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams",
14      "rel": "http://mms.mongodb.com/teams"
15    },
16    {
17      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/users",
18      "rel": "http://mms.mongodb.com/users"
19    }
20  ],
21  "name": "Organization Name 1"
22}

戻る

ロールを更新

次へ

削除