/ /

Claves de API en proyectos

Docs Home

/ /

Claves de API programáticas

Claves de API en proyectos

Claves de API programáticas

Claves de API en proyectos

Modificar los roles de una API Key de una Organización para un Proyecto

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del Proyecto cuyo Claves API que desea actualizar. Utilice el /groups punto final para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.
`API-KEY-ID`	string	Identificador único de la clave API que deseas actualizar. Solicita el endpoint /groups/{PROJECT-ID}/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).

1

elementosPorPágina

entero

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Indica si el cuerpo de la respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure "envelope" : true en la consulta.

Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

Para los endpoints que devuelven una lista de resultados, el objeto results es un sobre. Cloud Manager añade el campo status al cuerpo de la respuesta.

Ninguno

Parámetros del cuerpo de la solicitud

El parámetro body es obligatorio.

Nombre

Tipo

Necesidad

Descripción

roles

arreglo de string

Requerido

Lista de roles a los que se debe asignar la clave API. Se debe proporcionar al menos un rol. Todos los roles proporcionados deben ser válidos para el proyecto asignado:

Valor de Rol en API	rol
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`

Incluya todos los roles que desee que esta clave API tenga. Cualquier rol que no esté en este arreglo se elimina.

Respuesta

Nombre

Tipo

Descripción

desc

string

Descripción de esta clave API de la organización API asignada a este proyecto.

id

string

Identificador único para esta organización API clave asignada a este proyecto.

privateKey

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.

publicKey

string

Llave pública para esta organización API asignada a este proyecto.

roles

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.

roles.groupId

string

Identificador único del Proyecto al que pertenece este rol.

roles.orgId

string

Identificador único de la organización a la que pertenece este rol.

roles.roleName

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.orgId (organización), los valores incluyen:

Valor de Rol en API	rol
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_READ_ONLY`	`Organization Billing Viewer`

Roles del proyecto

Si esto es un roles.groupId (Proyecto), los valores incluyen:

Valor de Rol en API	rol
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`

Solicitud de ejemplo

Nota

El usuario que realiza la solicitud puede tener el formato {PUBLIC-KEY}:{PRIVATE-KEY}.

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d143c87d9d63e6d694746?pretty=true" \
6      --data '{
7          "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ]
8        }'

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Respuesta del cuerpo

1 {
2   "desc" : "New API key for test purposes",
3   "id" : "5d1d143c87d9d63e6d694746",
4   "links" : [ {
5     "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746",
6     "rel" : "self"
7   } ],
8   "privateKey" : "********-****-****-eac4256753ba",
9   "publicKey" : "{PUBLIC-KEY}",
10   "roles" : [ {
11     "orgId" : "5980cfe20b6d97029d82fa63",
12     "roleName" : "ORG_BILLING_ADMIN"
13   }, {
14     "groupId" : "{PROJECT-ID}",
15     "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
16   }, {
17     "orgId" : "5980cfe20b6d97029d82fa63",
18     "roleName" : "ORG_MEMBER"
19   }, {
20     "groupId" : "{PROJECT-ID}",
21     "roleName" : "GROUP_READ_ONLY"
22   } ]
23 }

Volver

Asignar a un proyecto

Unassign

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/5d1d143c87d9d63e6d694746?pretty=true" \
6	--data '{
7	"roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ]
8	}'

1	{
2	"desc" : "New API key for test purposes",
3	"id" : "5d1d143c87d9d63e6d694746",
4	"links" : [ {
5	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746",
6	"rel" : "self"
7	} ],
8	"privateKey" : "******--**-eac4256753ba",
9	"publicKey" : "{PUBLIC-KEY}",
10	"roles" : [ {
11	"orgId" : "5980cfe20b6d97029d82fa63",
12	"roleName" : "ORG_BILLING_ADMIN"
13	}, {
14	"groupId" : "{PROJECT-ID}",
15	"roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
16	}, {
17	"orgId" : "5980cfe20b6d97029d82fa63",
18	"roleName" : "ORG_MEMBER"
19	}, {
20	"groupId" : "{PROJECT-ID}",
21	"roleName" : "GROUP_READ_ONLY"
22	} ]
23	}