/ /

Claves de API programáticas

Claves API en proyectos

Docs Home

MongoDB Ops Manager

API

Recursos

Claves de API programáticas

Claves API en proyectos

Crear y asignar una clave API de organización a un proyecto

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

Todas las solicitudes a este punto final deben provenir de una dirección IP de la lista de acceso a la API del usuario de Ops Manager. Para obtener la documentación completa sobre la configuración de las listas de acceso a la API, consulte Solicite una lista de acceso API para su organización.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/apiKeys

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del Proyecto cuyo Claves API que desea recuperar. Utilice el punto de conexión /groups para recuperar todas las organizaciones a las 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:

Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

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

Ninguno

Parámetros del cuerpo de la solicitud

Se requiere al menos uno de los dos parámetros en el cuerpo.

Nombre

Tipo

Descripción

desc

string

Descripción de la clave API. Debe tener entre 1 y 250 caracteres.

roles

matriz de cadenas

Lista de roles que debe tener la clave API.Si roles se proporciona la matriz:

Proporcionar al menos un rol
Asegúrese de que todos los roles sean válidos para el proyecto.

Los roles del proyecto 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`

Respuesta

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 tiene esta clave API de esta organización asignada a este proyecto. Este arreglo retorna todos los roles de organización y Proyecto que el usuario tiene en Ops 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 Ops 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_READ_ONLY`	`Organization Read Only`

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 {USERNAME}:{APIKEY} o {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 POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true" \
6   --data '{
7     "desc" : "New API key for test purposes",
8     "roles": ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN"]
9   }'

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   "desc" : "New API key for test purposes",
3   "id" : "5d1d143c87d9d63e6d694746",
4   "links" : [ {
5     "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746",
6     "rel" : "self"
7   } ],
8   "privateKey" : "********-****-****-db2c132ca78d",
9   "publicKey" : "{PUBLIC-KEY}",
10   "roles" : [ {
11     "groupId" : "{PROJECT-ID}",
12     "roleName" : "GROUP_READ_ONLY"
13   }, {
14     "groupId" : "{PROJECT-ID}",
15     "roleName" : "GROUP_DATA_ACCESS_ADMIN"
16   } ]
17 }

Volver

Obtener todo

Asignar

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true" \
6	--data '{
7	"desc" : "New API key for test purposes",
8	"roles": ["GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN"]
9	}'

1	{
2	"desc" : "New API key for test purposes",
3	"id" : "5d1d143c87d9d63e6d694746",
4	"links" : [ {
5	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d143c87d9d63e6d694746",
6	"rel" : "self"
7	} ],
8	"privateKey" : "******--**-db2c132ca78d",
9	"publicKey" : "{PUBLIC-KEY}",
10	"roles" : [ {
11	"groupId" : "{PROJECT-ID}",
12	"roleName" : "GROUP_READ_ONLY"
13	}, {
14	"groupId" : "{PROJECT-ID}",
15	"roleName" : "GROUP_DATA_ACCESS_ADMIN"
16	} ]
17	}