URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del proyecto cuyos API deseas actualizar. Utiliza el endpoint /grupos para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
| string | Identificador único para la clave API que se desea actualizar. Se debe utilizar el punto final /groups/{ID del proyecto}/apiKeys para recuperar todas las claves API a las que el usuario autenticado tiene acceso para la organización especificada. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
Num. de pág. | entero | Número de página (basado en índice a partir de 1). |
|
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un formato prettyprint. |
|
envelope | booleano | Indica si se debe envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para corregir esto, establezca Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| arreglo | Requerido | Lista de roles que la clave de API debe tener asignados. Se debe proporcionar un mínimo de un rol. Todos los roles proporcionados deben ser válidos para el Proyecto asignado:
|
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Descripción de esta clave API de la organización API asignada a este proyecto. |
| string | Identificador único para esta organización API clave asignada a este proyecto. |
| string | Clave privada redactada para esta organización API clave asignada a este proyecto. Esta clave se muestra sin enmascarar cuando se crea por primera vez. |
| string | Llave pública para esta organización API asignada a este proyecto. |
| objeto arreglo | Roles que esta organización API clave asignada a este proyecto tiene. Este arreglo devuelve todos los roles de la Organización y del Proyecto que el usuario tiene en Cloud Manager. |
| string | Identificador único del Proyecto al que pertenece este rol. |
| string | Identificador único de la organización a la que pertenece este rol. |
| string | Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Cloud Manager. Los valores posibles son: Roles de la organización Si esto es una
Roles del proyecto Si esto es un
|
Solicitud de ejemplo
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/groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}?pretty=true" --data '{ "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ] }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "desc" : "test", "id" : "{API-KEY-ID}", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}", "rel" : "self" } ], "privateKey" : "********-****-****-1493e7bcfde9", "publicKey" : "{PUBLIC-KEY}", "roles" : [ { "groupId" : "{PROJECT-ID-1}", "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" }, { "groupId" : "{PROJECT-ID-1}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID-2}", "roleName" : "GROUP_READ_ONLY" }, { "orgId" : "{ORG-ID}", "roleName" : "ORG_MEMBER" } ]}