更新一个项目中的一个自定义角色

修补 /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}

在指定项目中更新一个自定义角色。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目所有者”角色、“项目流处理所有者”角色或“项目数据库访问管理员”角色。

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式:^([a-f0-9]{24})$

  • roleName 字符串 必需

    标识请求角色的人类可读标签。此名称必须是本项目中此自定义角色的唯一名称。

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false

    Prettyprint
application/vnd.atlas.2023-01-01+json

body 必需

在指定项目中更新一个自定义角色。

  • 操作 大量[对象]

    角色授予的各个权限操作的列表。

    角色授予的特权动作。

    隐藏操作属性 显示操作属性 对象
    • 操作 字符串 必需

      用于标识特权操作的可读标签。

      值为 FINDINSERTREMOVEUPDATEBYPASS_DOCUMENT_VALIDATIONUSE_UUIDKILL_OPBYPASS_DEFAULT_MAX_TIME_MSCREATE_COLLECTIONCREATE_INDEXDROP_COLLECTIONENABLE_PROFILERKILL_ANY_CURSORCHANGE_STREAMCOLL_MODCOMPACTCONVERT_TO_CAPPEDDROP_DATABASEDROP_INDEXRE_INDEXRENAME_COLLECTION_SAME_DBSET_USER_WRITE_BLOCKBYPASS_USER_WRITE_BLOCKLIST_SESSIONSKILL_ANY_SESSION, COLL_STATS, CONN_POOL_STATS, DB_HASH, DB_STATS, GET_CMD_LINE_OPTS, GET_LOG, GET_PARAMETER, GET_SHARD_MAP, HOST_INFO, IN_PROG, LIST_DATABASES, LIST_COLLECTIONS, LIST_INDEXESLIST_SHARDSNET_STATREPL_SET_GET_CONFIGREPL_SET_GET_STATUSSERVER_STATUSVALIDATESHARDING_STATETOPSQL_GET_SCHEMASQL_SET_SCHEMAVIEW_ALL_HISTORYOUT_TO_S3, OUT_TO_AZURE, OUT_TO_GCS, STORAGE_GET_CONFIG, STORAGE_SET_CONFIG, FLUSH_ROUTER_CONFIG, ENABLE_SHARDING, CHECK_METADATA_CONSISTENCY, MOVE_CHUNK, SPLIT_CHUNK, ANALYZE_SHARD_KEY, REFINE_COLLECTION_SHARD_KEY, CLEAR_JUMBO_FLAG, RESHARD_COLLECTIONSHARDED_DATA_DISTRIBUTIONGET_STREAM_PROCESSORCREATE_STREAM_PROCESSORPROCESS_STREAM_PROCESSORSTART_STREAM_PROCESSORSTOP_STREAM_PROCESSORDROP_STREAM_PROCESSORSAMPLE_STREAM_PROCESSORLIST_STREAM_PROCESSORSLIST_CONNECTIONSSTREAM_PROCESSOR_STATS

    • 资源 大量[对象]

      您授予操作的资源列表。

      此数据库用户有权访问权限的命名空间。

      隐藏资源属性 显示资源属性 对象
      • 集群 布尔 必需

        指示是否允许对集群资源执行动作的标志。如果为true , MongoDB Cloud 会忽略 actions.resources。集合和 actions.resources.db 参数。

      • 集合 字符串 必需

        人类可读标签,用于标识您向一个MongoDB用户授予动作的集合。如果不设立此参数,则会将该动作授予 actions.resources.db 参数中指定的数据库中的所有集合。如果设立"actions.resources.cluster" : true , MongoDB Cloud 会忽略此参数。

      • db 字符串 必需

        人类可读标签,用于标识您向一个MongoDB用户授予动作的数据库。如果设立"actions.resources.cluster" : true, MongoDB Cloud 会忽略此参数。

  • inheritedRoles 大量[对象]

    该自定义角色继承的内置角色列表。

    从此数据库用户的另一个上下文继承的角色。

    隐藏继承角色属性 显示继承角色属性 对象
    • db 字符串 必需

      人类可读标签,用于标识某人向一个MongoDB用户授予动作的数据库。

    • 角色 字符串 必需

      人类可读标签,用于标识继承的角色。对于除 readreadWrite 之外的每个角色,将此值设置为 admin

      MongoDB内置角色

响应

  • 200 application/vnd.atlas.2023-01-01+json

    正常

    隐藏响应属性 显示响应属性 对象
    • 操作 大量[对象]

      角色授予的各个权限操作的列表。

      角色授予的特权动作。

      隐藏操作属性 显示操作属性 对象
      • 操作 字符串 必需

        用于标识特权操作的可读标签。

        值为 FINDINSERTREMOVEUPDATEBYPASS_DOCUMENT_VALIDATIONUSE_UUIDKILL_OPBYPASS_DEFAULT_MAX_TIME_MSCREATE_COLLECTIONCREATE_INDEXDROP_COLLECTIONENABLE_PROFILERKILL_ANY_CURSORCHANGE_STREAMCOLL_MODCOMPACTCONVERT_TO_CAPPEDDROP_DATABASEDROP_INDEXRE_INDEXRENAME_COLLECTION_SAME_DBSET_USER_WRITE_BLOCKBYPASS_USER_WRITE_BLOCKLIST_SESSIONSKILL_ANY_SESSION, COLL_STATS, CONN_POOL_STATS, DB_HASH, DB_STATS, GET_CMD_LINE_OPTS, GET_LOG, GET_PARAMETER, GET_SHARD_MAP, HOST_INFO, IN_PROG, LIST_DATABASES, LIST_COLLECTIONS, LIST_INDEXESLIST_SHARDSNET_STATREPL_SET_GET_CONFIGREPL_SET_GET_STATUSSERVER_STATUSVALIDATESHARDING_STATETOPSQL_GET_SCHEMASQL_SET_SCHEMAVIEW_ALL_HISTORYOUT_TO_S3, OUT_TO_AZURE, OUT_TO_GCS, STORAGE_GET_CONFIG, STORAGE_SET_CONFIG, FLUSH_ROUTER_CONFIG, ENABLE_SHARDING, CHECK_METADATA_CONSISTENCY, MOVE_CHUNK, SPLIT_CHUNK, ANALYZE_SHARD_KEY, REFINE_COLLECTION_SHARD_KEY, CLEAR_JUMBO_FLAG, RESHARD_COLLECTIONSHARDED_DATA_DISTRIBUTIONGET_STREAM_PROCESSORCREATE_STREAM_PROCESSORPROCESS_STREAM_PROCESSORSTART_STREAM_PROCESSORSTOP_STREAM_PROCESSORDROP_STREAM_PROCESSORSAMPLE_STREAM_PROCESSORLIST_STREAM_PROCESSORSLIST_CONNECTIONSSTREAM_PROCESSOR_STATS

      • 资源 大量[对象]

        您授予操作的资源列表。

        此数据库用户有权访问权限的命名空间。

        隐藏资源属性 显示资源属性 对象
        • 集群 布尔 必需

          指示是否允许对集群资源执行动作的标志。如果为true , MongoDB Cloud 会忽略 actions.resources。集合和 actions.resources.db 参数。

        • 集合 字符串 必需

          人类可读标签,用于标识您向一个MongoDB用户授予动作的集合。如果不设立此参数,则会将该动作授予 actions.resources.db 参数中指定的数据库中的所有集合。如果设立"actions.resources.cluster" : true , MongoDB Cloud 会忽略此参数。

        • db 字符串 必需

          人类可读标签,用于标识您向一个MongoDB用户授予动作的数据库。如果设立"actions.resources.cluster" : true, MongoDB Cloud 会忽略此参数。

    • inheritedRoles 大量[对象]

      该自定义角色继承的内置角色列表。

      从此数据库用户的另一个上下文继承的角色。

      隐藏继承角色属性 显示继承角色属性 对象
      • db 字符串 必需

        人类可读标签,用于标识某人向一个MongoDB用户授予动作的数据库。

      • 角色 字符串 必需

        人类可读标签,用于标识继承的角色。对于除 readreadWrite 之外的每个角色,将此值设置为 admin

        MongoDB内置角色
    • roleName 字符串 必需

      标识请求角色的可读标签。此名称必须是此项目中此自定义角色的唯一名称。

  • 400 application/json

    错误请求。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 409 application/json

    冲突。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

PATCH /api/atlas/v2 /groups/{groupId}/customDBRoles/roles/{roleName}
atlas api customDatabaseRoles updateGroupCustomDbRoleRole --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.UpdateGroupCustomDbRoleRoleApiParams{}
	sdkResp, httpResp, err := client.CustomDatabaseRolesApi.
		UpdateGroupCustomDbRoleRoleWithParams(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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \
  -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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \
  -d '{ <Payload> }'
请求示例
{
  "actions": [
    {
      "action": "FIND",
      "resources": [
        {
          "cluster": true,
          "collection": "string",
          "db": "string"
        }
      ]
    }
  ],
  "inheritedRoles": [
    {
      "db": "string",
      "role": "string"
    }
  ]
}
响应示例 (200)
{
  "actions": [
    {
      "action": "FIND",
      "resources": [
        {
          "cluster": true,
          "collection": "string",
          "db": "string"
        }
      ]
    }
  ],
  "inheritedRoles": [
    {
      "db": "string",
      "role": "string"
    }
  ],
  "roleName": "string"
}
响应示例 (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
响应示例 (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
  "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"
}
响应示例 (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
响应示例 (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}