Atualizar funções de um usuário

Nesta página

Resource

Funções obrigatórias
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

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	`Organization Owner`
Projeto	`Project Owner`

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
`USER-ID`	string	Obrigatório	Identificador exclusivo do usuário que você deseja recuperar. Para recuperar o `USER-ID` para um usuário, consulte Obter todos os usuários em um projeto.

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.

false

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:

Nome	Descrição
Status	Código de resposta HTTP
envelope	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome

Tipo

necessidade

Descrição

roles

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 GLOBAL_ não exigem um groupId. Essas funções não estão vinculadas a um projeto.

roles

.roleName

string

Opcional

Nome da função. Os valores aceitos são:

Valor	Descrição
`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`

Resposta

O documento JSON contém cada um dos seguintes elementos:

Name

Tipo

Descrição

emailAddress

string

Endereço de e-mail do usuário do Ops Manager.

firstName

string

Nome do usuário do Ops Manager.

id

string

Identificador único do usuário do Ops Manager.

lastName

string

Sobrenome do usuário do Ops Manager.

links

array de objetos

Links para sub-recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. O relacionamento entre URLs é explicado na Especificação de links da web.

mobileNumber

string

Número de celular do usuário do Ops Manager.

roles

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 GLOBAL_ não exigem um groupId. Essas funções não estão vinculadas a um projeto.

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:

Valor	Descrição
`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

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

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}

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 }

Voltar

Criar um usuário

Criar o primeiro usuário

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	}