Docs Home

/ /

Claves API globales

Docs Home

/ /

Claves de API programáticas

Claves API globales

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Claves de API programáticas

Claves API globales

Crear una clave API global

Crea un Global Clave API para Ops Manager.

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

Resource

POST /admin/apiKeys

Roles necesarios

Requiere que la clave API que llama a este punto final tenga la Global Owner role.

Request Parameters

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Opcional

Bandera que 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 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

false

Parámetros del cuerpo de la solicitud

Debes proporcionar todos los parámetros del cuerpo de la solicitud.

Nombre

Tipo

Necesidad

Descripción

desc

string

Requerido

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

roles

matriz de cadenas

Requerido

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

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

Las funciones globales aceptadas por defecto incluyen:

Valor del rol en la API	rol
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Respuesta

Nombre

Tipo

Descripción

desc

string

Descripción de esta clave API global.

id

string

Identificador único para esta clave API global.

links

string

Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información.

privateKey

string

Clave privada sin redactar para esta clave API global.

publicKey

string

Clave pública para esta clave API global.

roles

matriz de objetos

Roles que tiene esta clave API global. Esta matriz devuelve todos los roles globales que el usuario tiene en Ops Manager.

roles.roleName

string

Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Ops Manager. Los valores posibles son:

Valor del rol en la API	rol
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global 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   --header "Content-Type: application/json" \
4   --include \
5   --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true" \
6   --data '{
7     "desc" : "New API key for Global Testing",
8     "roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_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 Global Testing",
3   "id" : "5d669ce780eef52a42cf0e1e",
4   "links" : [ {
5     "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
6     "rel" : "self"
7   } ],
8   "privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f",
9   "publicKey" : "cfswjfck",
10   "roles" : [ {
11     "roleName" : "GLOBAL_READ_ONLY"
12   }, {
13     "roleName" : "GLOBAL_USER_ADMIN"
14   } ]
15 }

Volver

Consigue uno

Update

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/admin/apiKeys?pretty=true" \
6	--data '{
7	"desc" : "New API key for Global Testing",
8	"roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_ADMIN" ]
9	}'

1	{
2	"desc" : "New API key for Global Testing",
3	"id" : "5d669ce780eef52a42cf0e1e",
4	"links" : [ {
5	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
6	"rel" : "self"
7	} ],
8	"privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f",
9	"publicKey" : "cfswjfck",
10	"roles" : [ {
11	"roleName" : "GLOBAL_READ_ONLY"
12	}, {
13	"roleName" : "GLOBAL_USER_ADMIN"
14	} ]
15	}