Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.
Agrega, actualiza o remueve los roles de un usuario dentro de una organización o proyecto. Por defecto, cualquier nuevo rol en organizaciones y proyectos no globales del payload envÃa primero a los usuarios una invitación a la organización o al proyecto. Puedes añadir usuarios directamente a una organización o proyecto solo si configuras la opción mms.user.bypassInviteForExistingUsers en true.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /users/{USER-ID}Roles necesarios
Debes tener los roles de Propietario apropiados para usar este endpoint API.
Nivel | Rol necesario |
|---|---|
organización | |
Proyecto |
Importante
Siempre puedes actualizar tu propia cuenta de usuario.
Si eres propietario de una organización o proyecto, puedes actualizar los roles de usuario de cualquier usuario que tenga membresÃa en esa organización o proyecto. No puedes modificar ninguna otra información de perfil de usuario.
Parámetros de ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Requerido | Identificador único del usuario que desea recuperar. Para recuperar el |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que 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 solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Arreglo de objetos | Requerido | Rol asignado al usuario de Ops Manager. |
| string | Opcional | Identificador único de la organización en la que el usuario de Ops Manager tiene el rol especificado. |
| string | Opcional | Identificador único del proyecto en el que el usuario de Ops Manager tiene el rol especificado. No se requiere un |
| 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 | Primer nombre del usuario de Ops Manager. |
| string | Identificador único del usuario de Ops Manager. |
| string | Apellido del usuario de Ops Manager. |
| objeto arreglo | Enlaces hacia recursos secundarios relacionados. Todos los |
| string | Número de móvil del usuario de Ops Manager. |
| Arreglo vacÃo | Rol asignado al usuario de Ops Manager. |
| string | Identificador único para el Proyecto en el que el usuario tiene el rol especificado. No se requiere un |
| string | Identificador único de la organización en la que el usuario tiene el rol especificado. |
| string | Nombre del rol. Los valores aceptados son:
|
| string | Nombre de usuario del usuario de Ops Manager. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}" \ --data ' { "roles": [{ "groupId": "{GROUP-ID}", "roleName": "{ROLE}" }] }'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
{ "id": "{USER-ID}", "username": "jane", "emailAddress": "jane@qa.example.com", "firstName": "Jane", "lastName": "D'oh", "links": [{ "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}", "rel": "self" }, { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}/accessList", "rel": "http://mms.mongodb.com/accessList" }], "roles": [{ "orgId": "{ORG-ID}", "roleName": "ORG_MEMBER" },{ "groupId": "{PROJECT-ID}", "roleName": "GROUP_READ_ONLY" }], "teamIds": []}