Atualizar funções de um usuário
Nesta página
Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.
Adicione, atualize ou remova as funções de um usuário dentro de uma organização ou projeto. Por padrão, qualquer nova organização não global e funções de projeto na carga útil enviam primeiro aos usuários um convite para a organização ou projeto . Você pode adicionar usuários diretamente a uma organização ou projeto somente se definir a configuração mms.user.bypassInviteForExistingUsers como true.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /users/{USER-ID}
Funções obrigatórias
Você deve ter as roles de Proprietário apropriadas para usar esse endpoint deAPI do .
Nível | Função necessária |
|---|---|
Organização | |
Projeto |
Importante
Você sempre pode atualizar sua própria conta de usuário.
Se você for proprietário de uma organização ou projeto, poderá atualizar as roles de usuário de qualquer usuário com uma adesão a essa organização ou projeto. Você não pode modificar nenhuma outra informação de perfil de usuário.
Parâmetros do caminho da solicitação
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Obrigatório | Identificador exclusivo do usuário que você deseja recuperar. Para recuperar o |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Nome | Tipo | necessidade | Descrição | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Array de objetos | Obrigatório | Função atribuída ao usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Opcional | Identificador único da organização na qual o usuário do Ops Manager tem o papel especificado. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Opcional | Identificador único do projeto no qual o usuário do Ops Manager tem o role especificado. As funções que começam com | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Opcional | Nome da função. Os valores aceitos são:
|
Resposta
O documento JSON contém cada um dos seguintes elementos:
Name | Tipo | Descrição | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Endereço de e-mail do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Nome do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Identificador único do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Sobrenome do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| array de objetos | Links para sub-recursos relacionados. Todas as arrays | ||||||||||||||||||||||||||||||||||||||||
| string | Número de celular do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| Array vazia | Função atribuída ao usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único do projeto no qual o usuário tem o papel especificado. As funções que começam com | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único para a organização na qual o usuário tem o papel especificado. | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Nome da função. Os valores aceitos são:
| ||||||||||||||||||||||||||||||||||||||||
| string | Nome de usuário do usuário do Ops Manager. |
Exemplo de solicitação
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 }'
Exemplo de resposta
Cabeçalho de resposta
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}
Corpo de resposta
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 }