Docs Menu
Docs Home
/ /
Claves API globales

Obtener todos los roles para claves API globales

Devolver una lista de roles globales aceptables para Global Claves API.

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

GET /admin/apiKeys/roles

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

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

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

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

Devuelve una matriz de todos los roles globales aceptables para las claves API globales.

Nota

El usuario que realiza la solicitud puede tener el formato {USERNAME}:{APIKEY} o {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{USERNAME}:{APIKEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?pretty=true"
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}
1{
2 [
3 "GLOBAL_BACKUP_ADMIN",
4 "GLOBAL_BILLING_ADMIN",
5 "GLOBAL_MONITORING_ADMIN",
6 "GLOBAL_READ_ONLY",
7 "GLOBAL_AUTOMATION_ADMIN",
8 "GLOBAL_USER_ADMIN"
9 ]
10}

Volver

Obtener todo

En esta página