Excluir um convite de uma organização
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Exclui um convite pendente para a organização especificada do Cloud Manager. Você não pode excluir um convite que um usuário aceitou.
Funções obrigatórias
Você pode chamar esse endpoint com sucesso com o role Organization User Admin .
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
DELETE /orgs/{ORG-ID}/invites/{INVITATION-ID}
Parâmetros do caminho da solicitação
Elemento do caminho | Tipo | necessidade | Descrição |
|---|---|---|---|
ORG-ID | string | Obrigatório | String única de 24 dígitos hexadecimais que identifica a organização. |
ID DE CLIQUE | string | Obrigatório | String exclusiva de 24 dígitos hexadecimais que identifica o convite. |
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 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:
| false |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Este endpoint não tem elementos de resposta.
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --request DELETE "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invitations/{INVITATION-ID}"
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
204 No Content 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
Este endpoint retorna um objeto JSON vazio.