/ /

Gerente de Operaciones

Actualizar roles para un usuario

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.

Add, update, or remove a user's roles within an organization or project. By default, any new non-global organization and project roles in the payload send users an invitation to the organization or project first. You can add users directly to an organization or project only if you set the mms.user.bypassInviteForExistingUsers estableciendo true en.

Resource

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PATCH /users/{USER-ID}

Roles necesarios

You must have the appropriate Owner roles to use this API endpoint.

Nivel	Rol necesario
Organización	`Organization Owner`
Proyecto	`Project Owner`

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
`USER-ID`	string	Requerido	Identificador único del usuario que desea recuperar. Para recuperar el `USER-ID` de un usuario, consulte Obtener todos los usuarios en un proyecto.

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 un impresión bonita formato.

false

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:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre

Tipo

Necesidad

Descripción

roles

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 GLOBAL_ no requieren groupId. Estos roles no están vinculados a ningún proyecto.

roles

.roleName

string

Opcional

Nombre del rol. Los valores aceptados son:

Valor	Descripción
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Respuesta

The JSON document contains each of the following elements:

Name

Tipo

Descripción

emailAddress

string

Dirección de correo electrónico del usuario Ops Manager.

firstName

string

Nombre del usuario Ops Manager.

id

string

Identificador único del usuario de Ops Manager.

lastName

string

Apellido del usuario Ops Manager.

links

matriz de objetos

Enlaces a subrecursos relacionados. Todas las links matrices en las respuestas incluyen al menos un enlace llamado "self". La relación entre las URL se explica en la Especificación de Enlaces Web.

mobileNumber

string

Número de móvil del usuario de Ops Manager.

roles

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 GLOBAL_ no requieren groupId. Estos roles no están vinculados a ningún proyecto.

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:

Valor	Descripción
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

username

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

HTTP/1.1 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

HTTP/1.1 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 }

Volver

Crear

Crear el primer usuario

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	}'

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	}