URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la organización cuyas claves de API desea recuperar. Utiliza el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
| string | Identificador único para la clave API que se desea actualizar. Haga una solicitud al punto de conexión /orgs/{ORG-ID}/apiKeys para recuperar todas las claves API a las que el usuario autenticado tiene acceso para la organización especificada. |
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 formato prettyprint. |
|
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 ni al código de estado. Para corregir esto, 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 |
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Obligatorio/Opcional | Descripción |
|---|---|---|---|
| string | Opcional | Descripción de la clave. Este parámetro es opcional; sin embargo, la solicitud debe contener un parámetro |
| arreglo de string | Opcional | Lista de roles que la API clave debe tener. Este parámetro es opcional; sin embargo, la solicitud debe contener un parámetro Los roles de la organización incluyen:
|
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la clave API |
| string | Descripción de la clave API |
| string | Clave privada redactada para la clave API |
| string | llave pública para la clave API |
| objeto arreglo | Roles que tiene la clave API |
| string | El |
| string | El nombre del rol. El recurso
|
Solicitud de ejemplo
Nota
El usuario que realiza la solicitud puede formatearse como {PUBLIC-KEY}:{PRIVATE-KEY}.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \ --data '{ "desc" : "Updated |api| key description for test purposes", "roles": ["ORG_MEMBER", "ORG_READ_ONLY"] }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "desc" : "Updated |api| key description for test purposes", "id" : "5c47ba5127d9d61b9fd8a27b", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "kzurbulc", "roles" : [ { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" }, { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_READ_ONLY" } ]}