Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos da API de administração do Cloud Manager
/
Organizações e equipes
/
Equipes

Atualizar roles de equipe em um projeto

Nesta página

  • Sintaxe
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • documento de resposta
  • results documento incorporado
  • Exemplo
  • Solicitar
  • Resposta

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.

URL base: https://cloud.mongodb.com/api/public/v1.0

Sintaxe

PATCH /groups/{PROJECT-ID}/teams/{TEAM-ID}

Parâmetros do caminho da solicitação

parâmetro de caminho
Tipo
necessidade
Descrição
PROJECT-ID
string
Obrigatório
Identificador único do projeto associado a esta equipe.
TEAM-ID
string
Obrigatório
Identificador exclusivo da equipe para a qual você deseja atualizar roles.

Solicitar parâmetros de query

Parâmetro de query
Tipo
necessidade
Descrição
envelope
booleano
Opcional

Sinalizador que especifica se deseja ou não envolver a resposta em um envelope.

Padrão é false.

pretty
booleano
Opcional

Sinalizador que especifica se deseja ou não retornar um documentoJSON "pretty-printed".

Padrão é false.

Parâmetros do corpo da solicitação

Especifique uma array de strings, onde cada string representa uma role que você deseja adicionar à equipe. Você deve especificar uma array mesmo se estiver associando apenas uma única role à equipe.

Parâmetro do corpo
Tipo
necessidade
Descrição
roleNames
array
Obrigatório
Funções do projeto que você deseja atribuir à equipe fornecida.

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição
results
array
A array inclui um objeto para cada item detalhado na seção Documento incorporadoresults .
links
array
A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
totalCount
número
Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada elemento na array result é um conjunto de funções especificadas para uma equipe.

Parâmetro de resposta
Tipo
Descrição
roleNames
array
Funções do projeto atribuídas à equipe para o teamsId especificado.
teamsId
string
Identificador único da equipe atribuída às funções listadas.

Exemplo

Solicitar

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}?pretty=true" \
     --data '{
        "roleNames": ["GROUP_OWNER"]
      }'

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}
{
  "links": [{
    "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}?pretty=true&pageNum=1&itemsPerPage=100",
    "rel": "self"
  }],
  "results": [{
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID1}",
      "rel": "self"
    }],
    "roleNames": ["GROUP_OWNER", "GROUP_BACKUP_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_AUTOMATION_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_USER_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_READ_ONLY"],
    "teamId": "{TEAM-ID1}"
  }, {
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID2}",
      "rel": "self"
    }],
    "roleNames": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"],
    "teamId": "{TEAM-ID2}"
  }, {
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}",
      "rel": "self"
    }],
    "roleNames": ["GROUP_OWNER"],
    "teamId": "{TEAM-ID3}"
  }],
  "totalCount": 3
}

Voltar

Renomear uma equipe

Próximo

Adicionar usuários à equipe