Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Atualizar convite de uma organização

Nesta página

  • Funções obrigatórias
  • Resource
  • 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

Atualiza um convite pendente para a organização do Ops Manager que você especificou.

Você pode chamar esse endpoint com sucesso com o role Organization User Admin .

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

PATCH /orgs/{ORG-ID}/invites
Elemento do caminho
Tipo
necessidade
Descrição

ORG-ID

string

Obrigatório

String única de 24 dígitos hexadecimais que identifica a organização.

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 da 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

content

Corpo de resposta esperado

false

Parâmetro do corpo
Tipo
necessidade
Descrição

roles

array de strings

Obrigatório

MongoDB Ops Manager a serem atribuídas ao usuárioconvidado .

Se o usuário aceitar o convite, o Ops Manager atribuirá essas funções a ele.

IMPORTANTE: o MongoDB Ops Manager substitui as funções no convite pelas funções que você fornece nesta solicitação. Certifique-se de incluir todas as funções que deseja atribuir ao usuário nesta solicitação.

nome de usuário

string

Obrigatório

Username of the user whose invitation you want to update. No Ops Manager, o nome de usuário de um usuário convidado é o endereço de e-mail para o qual o Ops Manager enviou o convite.

Nome
Tipo
Descrição

createdAt

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando MongoDB Ops Manager o enviou o convite.

expiresAt

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o convite expira.

Os usuários têm 30 dias para aceitar um convite para um projeto do Ops Manager.

id

string

String exclusiva de 24 dígitos hexadecimais que identifica o convite.

InvitationrUsername

string

Usuário do Ops Manager que chamou o nome de usuário para a organização.

orgId

string

String única de 24 dígitos hexadecimais que identifica a organização.

orgName

string

Nome da organização.

roles

array de strings

Funções do Ops Manager a serem atribuídas ao usuário convidado.

Se o usuário aceitar o convite, o Ops Manager atribuirá essas funções a ele.

teamIds

array de strings

Sequências exclusivas de 24 dígitos hexadecimais que identificam as equipes para as quais o usuário foi convidado a participar.

nome de usuário

string

Endereço de e-mail para o qual o Ops Manager enviou o convite.

Se o usuário aceitar o convite, ele usará esse endereço de e-mail como seu nome de usuário do Ops Manager.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --request PATCH "https://opsmanager.example.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true" \
5 --data '
6 {
7 "roles": [
8 "ORG_OWNER"
9 ],
10 "username": "wyatt.smith@example.com"
11 }'
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}
1{
2 "createdAt": "2021-02-18T21:05:40Z",
3 "expiresAt": "2021-03-20T21:05:40Z",
4 "id": "{INVITATION-ID}",
5 "inviterUsername": "admin@example.com",
6 "orgId": "{ORG-ID}",
7 "orgName": "{ORG-NAME}",
8 "roles": [
9 "ORG_OWNER"
10 ],
11 "teamIds": [],
12 "username": "wyatt.smith@example.com"
13}

Voltar

Atualizar por ID de convite