Docs Home

/ /

Claves API de organización

Docs Home

/ /

Claves de API programáticas

Claves API de organización

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Claves de API programáticas

Claves API de organización

Crear una clave API.

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

Resource

POST /orgs/{ORG-ID}/apiKeys

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	Identificador único para el organización cuyas claves de API deseas recuperar. Utiliza el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

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(a) pretty-print formato.

false

envelope

booleano

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

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, 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. Ops Manager agrega el campo status al cuerpo de la respuesta.

Ninguno

Parámetros del cuerpo de la solicitud

Todos los parámetros del cuerpo son obligatorios.

Nombre

Tipo

Descripción

desc

string

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

roles

arreglo de string

Lista de roles que debe tener la clave API. Debe haber al menos un rol en la lista y todos deben ser válidos para una organización.

Los roles de la organización incluyen:

Valor de Rol en API	rol
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_READ_ONLY`	`Organization Read Only`

Respuesta

Nombre

Tipo

Descripción

id

string

Identificador único para la clave API

desc

string

Descripción de la clave API

privateKey

string

Clave privada de la clave API. Esta clave aparece sin editar solo en el momento de su creación.

publicKey

string

Clave pública para la clave API

roles

objeto arreglo

Roles que tiene la clave API

roles.orgId

string

El orgId representa la organización a la que se aplica este rol.

roles.roleName

string

El nombre del rol. El recurso users devuelve todos los roles que el usuario tiene, ya sea en MongoDB Atlas u Ops Manager. Los valores posibles son:

Valor de Rol en API	rol
`ORG_OWNER`	`Organization Owner`
`ORG_MEMBER`	`Organization Member`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_READ_ONLY`	`Organization Read Only`

Solicitud de ejemplo

Nota

El usuario que realiza la solicitud puede formatearse como {PUBLIC-KEY}:{PRIVATE-KEY}.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request POST "https://<ops-manager-host>/api/public/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true" \
  --data '{
    "desc" : "New API key for test purposes",
    "roles": ["ORG_MEMBER"]
  }'

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

Nota

El privateKey aparece sin ocultar en el cuerpo de la respuesta. Este ejemplo está redactado por razones de seguridad.

{
  "desc" : "New API key for test purposes",
  "id" : "{API-KEY-ID}",
  "links" : [ {
    "href" : "https://<ops-manager-host>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "{PUBLIC-KEY}",
  "roles" : [ {
    "orgId" : "{ORG-ID}",
    "roleName" : "ORG_MEMBER"
  } ]
}

Volver

Obtenga uno

Update