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

Actualizar una API Key Global

Actualizar valores de un Global Clave API de Ops Manager que utiliza el identificador único para esa clave.

Para encontrar una clave API global específica, Obtenga la lista de claves API globales y luego busque la {API-KEY-ID} Necesitas.

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

Resource

PATCH /admin/apiKeys/{API-KEY-ID}

Roles necesarios

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

Request Parameters

Parámetros de la ruta de solicitud

Todos los parámetros de ruta de la solicitud son obligatorios.

Nombre	Tipo	Descripción
`API-KEY-ID`	string	Identificador único de la clave API global que desea actualizar.

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

Debe proporcionar uno o ambos de los dos parámetros corporales.

Nombre

Tipo

Necesidad

Descripción

desc

string

Condicional

Descripción de la clave. Este parámetro es opcional; sin embargo, la solicitud debe contener un parámetro desc o un parámetro roles. Si se proporciona desc, debe tener entre 1 y 250 caracteres.

roles

matriz de cadenas

Condicional

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 redactada 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   --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \
5   --data '{
6     "desc" : "Updated API key description for test purposes"
7   }'

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   "created": "2019-09-04T15:37:40Z",
3   "desc": "Updated API key description for test purposes",
4   "globalRoles": ["GLOBAL_READ_ONLY"],
5   "groupRoles": [],
6   "numGroups": 0,
7   "orgRoles": [],
8   "orgRolesString": "",
9   "privateKey": "********-****-****-cfe60e9f1f72",
10   "userId": "5d6fda44ff4ab7133648a852",
11   "username": "dczverfw"
12 }

Volver

Crear

Borrar

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \
5	--data '{
6	"desc" : "Updated API key description for test purposes"
7	}'

1	{
2	"created": "2019-09-04T15:37:40Z",
3	"desc": "Updated API key description for test purposes",
4	"globalRoles": ["GLOBAL_READ_ONLY"],
5	"groupRoles": [],
6	"numGroups": 0,
7	"orgRoles": [],
8	"orgRolesString": "",
9	"privateKey": "******--**-cfe60e9f1f72",
10	"userId": "5d6fda44ff4ab7133648a852",
11	"username": "dczverfw"
12	}