Devuelve una lista de Roles Globales aceptables para Global API Keys.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys/roles
Roles necesarios
Requiere que la clave de API que llama a este endpoint tenga la
Global Read Only rol.
Request Parameters
Parámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
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). |
| ||||
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
| ||||
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un(a) pretty-print formato. |
| ||||
envelope | booleano | Indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP o al código de estado. Para remediarlo, establezca Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Respuesta
Devuelve un arreglo de todos los roles globales aceptables para las claves de API globales.
Solicitud de ejemplo
Nota
El usuario que realiza la solicitud puede ser formateado como {USERNAME}:{APIKEY} o {PUBLIC-KEY}:{PRIVATE-KEY}.
1 curl --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"
Respuesta de ejemplo
Encabezado de respuesta
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
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
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 }