Criar conta de serviço organizacional

POSTAR /api/v1/organizations/{id}/service-accounts

Cria uma conta de serviço ao cliente com escopo organizacional e retorna seu segredo uma vez. roles é necessário e aceita no máximo um nome não em branco: ORG_GROUP_CREATOR ou ORG_READ_ONLY. Os nomes do Agent Engine legado (ORG_ADMIN, ORG_MEMBER) ainda são aceitos. role_assignments repete a função armazenada do Mecanismo do agente. Exige ORG_ADMIN.

parâmetros de caminho

  • id string Obrigatório

    ID da organização

aplicação/json

corpo, corpo Obrigatório

Criar solicitação

  • Descrição string

    O comprimento máximo é 500.

  • ip_access_list array[string]

    Lista de permissões de IP/CIDR opcional. Vazio ou omitido significa irrestrito. No máximo 100 entradas.

    Não mais do que 100 elementos.

  • name string Obrigatório

    O comprimento máximo é 100.

  • roles array[string] Obrigatório

    Roles é o conjunto inicial de roles. Exatamente uma função é necessária. Contas de organização aceitam ORG_GROUP_CREATOR ou ORG_READ_ONLY. As contas de projeto aceitam PROJECT_OWNER, PROJECT_READ_ONLY ou AGENT_DEVELOPER. Os nomes do Agent Engine legado (ORG_ADMIN, ORG_MEMBER, PROJECT_MEMBER) ainda são aceitos. role_assignments repete a função armazenada do Agent Engine para a qual esses nomes são resolvidos.

    Pelo menos 1, mas não mais que 1 elemento.

  • secret_expires_after_hours inteiro

    TTL secreto opcional em horas. O padrão é 2160 (90 dias) quando omitido.

Respostas

  • Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

  • 201

    Criado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • client_secret string
    • service_account objeto
      Ocultar atributos service_account Mostrar atributos service_account objeto
      • Active_secret objeto
        Ocultar atributos Active_secret Mostrar atributos Active_secret objeto
        • created_at string
        • expires_at string
        • last_used_at string
        • masked_value string
      • client_id string
      • created_at string
      • Descrição string
      • id string
      • ip_access_list array[string]
      • is_active booleano
      • is_system_managed booleano
      • name string
      • org_id string
      • Proprietário(a) string
      • PROJECT_ID string
      • role_assignments array[objeto]
        Ocultar atributos role_assignments Mostrar atributos role_assignments objeto
        • org_id string
        • PROJECT_ID string
        • papel string
      • type string
      • updated_at string
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • client_secret string
    • service_account objeto
      Ocultar atributos service_account Mostrar atributos service_account objeto
      • Active_secret objeto
        Ocultar atributos Active_secret Mostrar atributos Active_secret objeto
        • created_at string
        • expires_at string
        • last_used_at string
        • masked_value string
      • client_id string
      • created_at string
      • Descrição string
      • id string
      • ip_access_list array[string]
      • is_active booleano
      • is_system_managed booleano
      • name string
      • org_id string
      • Proprietário(a) string
      • PROJECT_ID string
      • role_assignments array[objeto]
        Ocultar atributos role_assignments Mostrar atributos role_assignments objeto
        • org_id string
        • PROJECT_ID string
        • papel string
      • type string
      • updated_at string
  • Solicitação inválida

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Proibido

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Não encontrado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Conflito

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 429

    Muitas solicitações

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • Tentar novamente depois string

      Segundos para esperar antes de tentar novamente

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • Erro interno do servidor

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 503

    Serviço indisponível

    Ocultar atributo de cabeçalhos Mostrar atributo de cabeçalhos
    • Tentar novamente depois string

      Segundos para esperar antes de tentar novamente

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
POST /api/v1/organizations/{id}/service-accounts
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/organizations/{id}/service-accounts' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "ip_access_list": [
    "string"
  ],
  "name": "string",
  "roles": [
    "string"
  ],
  "secret_expires_after_hours": 42
}'
Exemplos de solicitação
{
  "description": "string",
  "ip_access_list": [
    "string"
  ],
  "name": "string",
  "roles": [
    "string"
  ],
  "secret_expires_after_hours": 42
}
Exemplos de resposta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (201)
{
  "client_secret": "string",
  "service_account": {
    "active_secret": {
      "created_at": "string",
      "expires_at": "string",
      "last_used_at": "string",
      "masked_value": "string"
    },
    "client_id": "string",
    "created_at": "string",
    "description": "string",
    "id": "string",
    "ip_access_list": [
      "string"
    ],
    "is_active": true,
    "is_system_managed": true,
    "name": "string",
    "org_id": "string",
    "owner": "string",
    "project_id": "string",
    "role_assignments": [
      {
        "org_id": "string",
        "project_id": "string",
        "role": "string"
      }
    ],
    "type": "string",
    "updated_at": "string"
  }
}
Exemplos de resposta (201)
{
  "client_secret": "string",
  "service_account": {
    "active_secret": {
      "created_at": "string",
      "expires_at": "string",
      "last_used_at": "string",
      "masked_value": "string"
    },
    "client_id": "string",
    "created_at": "string",
    "description": "string",
    "id": "string",
    "ip_access_list": [
      "string"
    ],
    "is_active": true,
    "is_system_managed": true,
    "name": "string",
    "org_id": "string",
    "owner": "string",
    "project_id": "string",
    "role_assignments": [
      {
        "org_id": "string",
        "project_id": "string",
        "role": "string"
      }
    ],
    "type": "string",
    "updated_at": "string"
  }
}
Exemplos de resposta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (403)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (404)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (409)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500)
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (503)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}