1 人の MongoDB Cloud ユーザーのプロジェクト ロールを更新
非推奨
指定されたプロジェクト内の指定されたユーザーのロールを更新します。更新するユーザーを指定するには、指定されたプロジェクト内のユーザーを識別するユニークな 24 桁の 16 進数の文字列を入力します。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーがグループ ユーザー管理者ロールを持っている必要があります。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。 -
変更するユーザーを識別する、ユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
クエリ パラメータ
-
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint -
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。
body
必須
指定したユーザーについて更新するロール。
-
MongoDB Cloud ユーザーに割り当てる 1 件以上のプロジェクト レベルのロール。
値は、
GROUP_BACKUP_MANAGER
、GROUP_CLUSTER_MANAGER
、GROUP_DATA_ACCESS_ADMIN
、GROUP_DATA_ACCESS_READ_ONLY
、GROUP_DATA_ACCESS_READ_WRITE
、GROUP_DATABASE_ACCESS_ADMIN
、GROUP_OBSERVABILITY_VIEWER
、GROUP_OWNER
、GROUP_READ_ONLY
、GROUP_SEARCH_INDEX_EDITOR
、またはGROUP_STREAM_PROCESSING_OWNER
です。
atlas api projects updateGroupUserRoles --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateGroupUserRolesApiParams{}
sdkResp, httpResp, err := client.ProjectsApi.
UpdateGroupUserRolesWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \
-d '{ <Payload> }'
{
"groupRoles": [
"GROUP_BACKUP_MANAGER"
]
}
{
"groupRoles": [
"GROUP_BACKUP_MANAGER"
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}