/ /

Claves API en proyectos

Docs Home

/ /

Claves de API programáticas

Claves API en proyectos

Claves de API programáticas

Claves API en proyectos

Obtener todas las claves API de la organización asignadas a un proyecto

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

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

Resource

GET /groups/{PROJECT-ID}/apiKeys

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del Proyecto del cual desea recuperar su Organización asignada Claves API. Utilice las /groups punto final para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Descripción

predeterminado

número de página

entero

Número de página (basado en el índice 1).

1

artículos por página

entero

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

100

bonita

booleano

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

false

envolvente

booleano

Indica si se debe envolver o no 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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`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

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en la `results` sección Documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es una clave API del proyecto.

Nombre

Tipo

Descripción

desc

string

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

id

string

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

privateKey

string

Clave privada redactada para esta organización Clave API asignada a este proyecto.

Esta clave se muestra sin enmascarar cuando se crea por primera vez.

publicKey

string

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

roles

matriz de objetos

Roles que esta clave API de organización tiene asignados a este proyecto. Esta matriz devuelve todos los roles de organización y 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 se trata de una roles.orgId (Organización), los valores incluyen:

Valor del rol en la 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 se trata de un roles.groupId (Proyecto), los valores incluyen:

Valor del rol en la 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`

Ejemplo de solicitud

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      --include \
4      --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true"

Ejemplo de respuesta

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}

Cuerpo de respuesta

1 {
2   "links" : [ {
3     "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "desc" : "Updated API Key description for DOCSP-6042",
8     "id" : "5d1cf1f980eef570c9fc87e5",
9     "links" : [ {
10       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11       "rel" : "self"
12     } ],
13     "privateKey" : "********-****-****-9d4ae38e4ddd",
14     "publicKey" : "{PUBLIC-KEY}",
15     "roles" : [ {
16       "groupId" : "{PROJECT-ID}",
17       "roleName" : "GROUP_AUTOMATION_ADMIN"
18     }, {
19       "groupId" : "{PROJECT-ID}",
20       "roleName" : "GROUP_MONITORING_ADMIN"
21     }, {
22       "orgId" : "5980cfe20b6d97029d82fa63",
23       "roleName" : "ORG_MEMBER"
24     }, {
25       "orgId" : "5980cfe20b6d97029d82fa63",
26       "roleName" : "ORG_BILLING_ADMIN"
27     }, {
28       "groupId" : "{PROJECT-ID}",
29       "roleName" : "GROUP_DATA_ACCESS_ADMIN"
30     }, {
31       "groupId" : "{PROJECT-ID}",
32       "roleName" : "GROUP_USER_ADMIN"
33     }, {
34       "groupId" : "{PROJECT-ID}",
35       "roleName" : "GROUP_READ_ONLY"
36     }, {
37       "groupId" : "{PROJECT-ID}",
38       "roleName" : "GROUP_OWNER"
39     }, {
40       "orgId" : "5980cfe20b6d97029d82fa63",
41       "roleName" : "ORG_OWNER"
42     }, {
43       "groupId" : "{PROJECT-ID}",
44       "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
45     }, {
46       "orgId" : "5980cfe20b6d97029d82fa63",
47       "roleName" : "ORG_GROUP_CREATOR"
48     }, {
49       "orgId" : "5980cfe20b6d97029d82fa63",
50       "roleName" : "ORG_READ_ONLY"
51     }, {
52       "groupId" : "{PROJECT-ID}",
53       "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54     }, {
55       "groupId" : "{PROJECT-ID}",
56       "roleName" : "GROUP_BACKUP_ADMIN"
57     }, {
58       "groupId" : "{PROJECT-ID}",
59       "roleName" : "GROUP_CLUSTER_MANAGER"
60     } ]
61   }, {
62     "desc" : "New API key for test purposes",
63     "id" : "5d1d12c087d9d63e6d682438",
64     "links" : [ {
65       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
66       "rel" : "self"
67     } ],
68     "privateKey" : "********-****-****-cb34f12aafdb",
69     "publicKey" : "oxhzytwb",
70     "roles" : [ {
71       "groupId" : "{PROJECT-ID}",
72       "roleName" : "GROUP_READ_ONLY"
73     }, {
74       "orgId" : "5980cfe20b6d97029d82fa63",
75       "roleName" : "ORG_MEMBER"
76     }, {
77       "orgId" : "5980cfe20b6d97029d82fa63",
78       "roleName" : "ORG_BILLING_ADMIN"
79     } ]
80   } ],
81   "totalCount" : 2
82 }

Volver

Claves API en proyectos

Crear y asignar

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true"

1	{
2	"links" : [ {
3	"href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"desc" : "Updated API Key description for DOCSP-6042",
8	"id" : "5d1cf1f980eef570c9fc87e5",
9	"links" : [ {
10	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11	"rel" : "self"
12	} ],
13	"privateKey" : "******--**-9d4ae38e4ddd",
14	"publicKey" : "{PUBLIC-KEY}",
15	"roles" : [ {
16	"groupId" : "{PROJECT-ID}",
17	"roleName" : "GROUP_AUTOMATION_ADMIN"
18	}, {
19	"groupId" : "{PROJECT-ID}",
20	"roleName" : "GROUP_MONITORING_ADMIN"
21	}, {
22	"orgId" : "5980cfe20b6d97029d82fa63",
23	"roleName" : "ORG_MEMBER"
24	}, {
25	"orgId" : "5980cfe20b6d97029d82fa63",
26	"roleName" : "ORG_BILLING_ADMIN"
27	}, {
28	"groupId" : "{PROJECT-ID}",
29	"roleName" : "GROUP_DATA_ACCESS_ADMIN"
30	}, {
31	"groupId" : "{PROJECT-ID}",
32	"roleName" : "GROUP_USER_ADMIN"
33	}, {
34	"groupId" : "{PROJECT-ID}",
35	"roleName" : "GROUP_READ_ONLY"
36	}, {
37	"groupId" : "{PROJECT-ID}",
38	"roleName" : "GROUP_OWNER"
39	}, {
40	"orgId" : "5980cfe20b6d97029d82fa63",
41	"roleName" : "ORG_OWNER"
42	}, {
43	"groupId" : "{PROJECT-ID}",
44	"roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
45	}, {
46	"orgId" : "5980cfe20b6d97029d82fa63",
47	"roleName" : "ORG_GROUP_CREATOR"
48	}, {
49	"orgId" : "5980cfe20b6d97029d82fa63",
50	"roleName" : "ORG_READ_ONLY"
51	}, {
52	"groupId" : "{PROJECT-ID}",
53	"roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54	}, {
55	"groupId" : "{PROJECT-ID}",
56	"roleName" : "GROUP_BACKUP_ADMIN"
57	}, {
58	"groupId" : "{PROJECT-ID}",
59	"roleName" : "GROUP_CLUSTER_MANAGER"
60	} ]
61	}, {
62	"desc" : "New API key for test purposes",
63	"id" : "5d1d12c087d9d63e6d682438",
64	"links" : [ {
65	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
66	"rel" : "self"
67	} ],
68	"privateKey" : "******--**-cb34f12aafdb",
69	"publicKey" : "oxhzytwb",
70	"roles" : [ {
71	"groupId" : "{PROJECT-ID}",
72	"roleName" : "GROUP_READ_ONLY"
73	}, {
74	"orgId" : "5980cfe20b6d97029d82fa63",
75	"roleName" : "ORG_MEMBER"
76	}, {
77	"orgId" : "5980cfe20b6d97029d82fa63",
78	"roleName" : "ORG_BILLING_ADMIN"
79	} ]
80	} ],
81	"totalCount" : 2
82	}

Resource

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Ejemplo de solicitud

Nota

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado