Criar uma chave API da organização

POSTAR /api/atlas/v1.0/orgs/{orgId}/apiKeys

Cria uma chave de API para a organização especificada. Uma chave de API da organização concede acesso programático a uma organização. Você não pode usar a chave de API para fazer login no console. Para usar este recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário da organização.

Chaves de API programáticas

parâmetros de caminho

orgId string Obrigatório

String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.

O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

envelope booleano

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

O valor padrão é false.
pretty booleano

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

O valor padrão é false.

Prettyprint

aplicação/json

corpo, corpo Obrigatório

Chave de API da organização a ser criada.

desc string Obrigatório

Finalidade ou explicação fornecida quando alguém criou esta chave de API da organização.

O comprimento mínimo é 1, o comprimento máximo é 250.
roles array[string] Obrigatório

Lista de funções para conceder esta chave API. Se você fornecer esta lista, forneça no mínimo uma função e garanta que cada função se aplique a esta organização.

Pelo menos 1 elemento. Os valores são ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN ou ORG_READ_ONLY.

Respostas

200 aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- desc string
  
  Finalidade ou explicação fornecida quando alguém criou esta chave de API da organização.
  
  O comprimento mínimo é 1, o comprimento máximo é 250.
- id string
  
  Sequência exclusiva de 24dígitos hexadecimais que identifica esta chave API da organização atribuída a este projeto.
  
  O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
- links array[objeto]
  
  Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.
  
  Especificação de links da web (RFC...
  
  Ocultar atributos dos links Mostrar atributos dos links objeto
  
  href string
  
  Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.
- chave privada string
  
  Chave privada editada retornada para esta chave de API da organização . Essa chave é exibida sem edição quando criada pela primeira vez.
- publicKey string
  
  Valor da chave de API pública definido para a chave de API da organização especificada.
  
  O comprimento mínimo é 8, o comprimento máximo é 8.
- roles array[objeto]
  
  Lista que contém as funções que a chave API precisa ter. Todas as funções fornecidas devem ser válidas para o projeto ou organização especificada . Cada solicitação deve incluir um mínimo de uma função válida. O recurso retorna todas as roles de projeto e organização atribuídas à chave de API.
  
  As roles do usuário da MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Cada função pode ser aplicada a uma organização ou a um projeto , mas não a ambos.
  
  Ocultar atributos de roles Mostrar atributos de funções objeto
  
  groupId string
  
  24String única de dígitos hexadecimais que identifica o projeto ao qual esta role pertence. Você pode definir um valor para esse parâmetro ou orgId, mas não ambos na mesma solicitação.
  
  O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  orgId string
  
  24String única de dígitos hexadecimais que identifica a organização à qual pertence esta função. Você pode definir um valor para esse parâmetro ou groupId, mas não ambos na mesma solicitação.
  
  O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
  
  roleName string
  
  Etiqueta legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a uma chave de API específica, a um usuário do MongoDB Cloud ou a uma equipe do MongoDB Cloud. Essas funções incluem funções de nível de organização e de projeto.
  
  Os valores são ORG_MEMBER, ORG_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_GROUP_CREATOR, ORG_OWNER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_CLUSTER_MANAGER, GROUP_SEARCH_INDEX_EDITOR, GROUP_STREAM_PROCESSING_OWNER, GROUP_BACKUP_MANAGER, GROUP_OBSERVABILITY_VIEWER ou GROUP_DATABASE_ACCESS_ADMIN.
401 aplicação/json

Não autorizado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
403 aplicação/json

Forbidden.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
404 aplicação/json

Não encontrado.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.
500 aplicação/json

Erro interno do servidor.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- badRequestDetail objeto
  
  Detalhes da solicitação inválida.
  
  Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
  
  Campos array[objeto]
  
  Descreve todas as violações em uma solicitação do cliente .
  
  Ocultar atributos de campos Mostrar atributos dos campos objeto
  
  Descrição string Obrigatório
  
  Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.
  
  Campo string Obrigatório
  
  Um caminho que leva a um campo no corpo da solicitação.
- detalhe string
  
  Descreve as condições ou os motivos específicos que causam cada tipo de erro.
- Erro integer(int32) Obrigatório
  
  O código de status HTTP retornado com este erro.
  
  Documentação externa
- Código de erro string Obrigatório
  
  Código de erro do aplicativo retornado com esse erro.
- Parâmetros array[objeto]
  
  Parâmetros usados para fornecer mais informações sobre o erro.
- Razão string
  
  Mensagens de erro de aplicativo retornadas com este erro.

POST /API/atlas/v1.0/orgs/{orgId}/apiKeys

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/apiKeys' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"desc":"string","roles":["ORG_OWNER"]}'

Exemplos de solicitação

{
  "desc": "string",
  "roles": [
    "ORG_OWNER"
  ]
}

Exemplos de resposta (200)

{
  "desc": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "privateKey": "55c3bbb6-b4bb-0be1-e66d20841f3e",
  "publicKey": "zmmrboas",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ]
}

Exemplos de resposta (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Exemplos de resposta (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Exemplos de resposta (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Exemplos de resposta (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}