Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.
Agregue, actualice o elimine los roles de un usuario dentro de una organización o proyecto. De forma predeterminada, cualquier nuevo rol de organización o proyecto no global en la carga envía primero a los usuarios una invitación a la organización o proyecto. Puede agregar usuarios directamente a una organización o proyecto solo si configura la opción mms.user.bypassInviteForExistingUsers estableciendo true en.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /users/{USER-ID}
Roles necesarios
Debe tener los roles de propietario adecuados para usar esto Punto final de API.
Nivel | Rol necesario |
|---|---|
Organización | |
Proyecto |
Importante
Siempre puedes actualizar tu propia cuenta de usuario.
Si posee una organización o un proyecto, puede actualizar los roles de usuario de cualquier usuario miembro de dicha organización o proyecto. No puede modificar la información de ningún otro perfil de usuario.
Parámetros de la ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Requerido | Identificador único del usuario que desea recuperar. Para recuperar el |
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 formato prettyprint formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Necesidad | Descripción | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| matriz de objetos | Requerido | Rol asignado al usuario Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Opcional | Identificador único de la organización en la que el usuario Ops Manager tiene el rol especificado. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Opcional | Identificador único del proyecto en el que el usuario Ops Manager tiene el rol especificado. Los roles que empiezan por | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Opcional | Nombre del rol. Los valores aceptados son:
|
Respuesta
El documento JSON contiene cada uno de los siguientes elementos:
Name | Tipo | Descripción | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Dirección de correo electrónico del usuario Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Nombre del usuario Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Identificador único del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Apellido del usuario Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| matriz de objetos | Enlaces a subrecursos relacionados. Todas las | ||||||||||||||||||||||||||||||||||||||||
| string | Número de móvil del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| matriz vacía | Rol asignado al usuario Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único del proyecto en el que el usuario tiene el rol especificado. Los roles que empiezan por | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único de la organización en la que el usuario tiene el rol especificado. | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Nombre del rol. Los valores aceptados son:
| ||||||||||||||||||||||||||||||||||||||||
| string | Nombre de usuario del usuario Ops Manager. |
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/users/{USER-ID}" \ 6 --data ' 7 { 8 "roles": [{ 9 "groupId": "{GROUP-ID}", 10 "roleName": "{ROLE}" 11 }] 12 }'
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 "id": "{USER-ID}", 3 "username": "jane", 4 "emailAddress": "jane@qa.example.com", 5 "firstName": "Jane", 6 "lastName": "D'oh", 7 "links": [{ 8 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}", 9 "rel": "self" 10 }, 11 { 12 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}/accessList", 13 "rel": "http://mms.mongodb.com/accessList" 14 }], 15 "roles": [{ 16 "orgId": "{ORG-ID}", 17 "roleName": "ORG_MEMBER" 18 },{ 19 "groupId": "{PROJECT-ID}", 20 "roleName": "GROUP_READ_ONLY" 21 }], 22 "teamIds": [] 23 }