URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Unique identifier for the Project whose API keys you want to update. Use the /groups punto final para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
| string | Identificador único de la clave API que desea actualizar. Solicite al punto de conexión /groups/{PROJECT-ID}/apiKeys que recupere todas las claves API a las que el usuario autenticado tiene acceso para la organización especificada. |
Parámetros de consulta de solicitud
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). |
| ||||
artículos por página | entero | Número de artículos a devolver por página, hasta un máximo de 500. |
| ||||
bonita | booleano | Indica si el cuerpo de la respuesta debe estar en un impresión bonita formato. |
| ||||
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 Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
Para los puntos finales que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Necesidad | Descripción | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| arreglo | Requerido | List of roles that the API Key should be granted. A minimum of one role must be provided. Any roles provided must be valid for the assigned Project:
|
Respuesta
Nombre | Tipo | Descripción | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Description of this Organization API key assigned to this Project. | ||||||||||||||||||||||||||||||
| string | Unique identifier for this Organization API key assigned to this Project. | ||||||||||||||||||||||||||||||
| string | Redacted Private key for this Organization API key assigned to this Project. Esta clave se muestra sin enmascarar cuando se crea por primera vez. | ||||||||||||||||||||||||||||||
| string | Public key for this Organization API key assigned to this Project. | ||||||||||||||||||||||||||||||
| matriz de objetos | Roles que tiene esta clave API de esta organización asignada a este proyecto. Este arreglo retorna todos los roles de organización y Proyecto que el usuario tiene en Ops Manager. | ||||||||||||||||||||||||||||||
| string | Identificador único del Proyecto al que pertenece este rol. | ||||||||||||||||||||||||||||||
| string | Identificador único de la Organización a la que pertenece este rol. | ||||||||||||||||||||||||||||||
| string | Nombre del rol. Este recurso devuelve todos los roles que el usuario tiene en Ops Manager. Los valores posibles son: Roles de la organización Si se trata de una
Roles del proyecto Si se trata de un
|
Ejemplo de solicitud
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/apiKeys/{API-KEY-ID}?pretty=true" \ 6 --data '{ 7 "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ] 8 }'
Ejemplo de respuesta
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}
Cuerpo de respuesta
1 { 2 "desc" : "test", 3 "id" : "{API-KEY-ID}", 4 "links" : [ { 5 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}", 6 "rel" : "self" 7 } ], 8 "privateKey" : "********-****-****-1493e7bcfde9", 9 "publicKey" : "{PUBLIC-KEY}", 10 "roles" : [ { 11 "groupId" : "{PROJECT-ID-1}", 12 "roleName" : "GROUP_DATA_ACCESS_READ_WRITE" 13 }, { 14 "groupId" : "{PROJECT-ID-1}", 15 "roleName" : "GROUP_READ_ONLY" 16 }, { 17 "groupId" : "{PROJECT-ID-2}", 18 "roleName" : "GROUP_READ_ONLY" 19 }, { 20 "orgId" : "{ORG-ID}", 21 "roleName" : "ORG_MEMBER" 22 } ] 23 }