parâmetros de caminho

• federationSettingsId string Obrigatório

  String exclusiva de 24 dígitos hexadecimais que identifica sua federação.

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

• identityProviderId string Obrigatório

  String legada com 20 dígitos hexadecimais que identifica o provedor de identidade. Essa ID pode ser encontrada na guia Console de Gerenciamento de Federação > Provedores de Identidade, clicando no ícone de informações na linha ID do IdP de um provedor de identidade configurado.

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

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.

Respostas

• 200 aplicação/json

  OK

  Ocultar atributos de resposta Mostrar atributos de resposta objeto

  • acsUrl string

    URL que indica aonde enviar a resposta SAML.

  • associatedDomains array[string]

    Lista que contém os domínios associados ao provedor de identidade.

  • associatedOrgs array[objeto]

    Lista que contém as configurações da organização conectada associadas ao provedor de identidade.

    Ocultar atributos associatedOrgs Mostrar atributos associatedOrgs objeto

    • dataAccessIdentityProviderIds array[string]

      A collection de IDs únicos que representam os fornecedores de identidade que podem ser usados para acesso a dados nessa organização.

    • domainAllowList array[string]

      Domínios aprovados que restringem os usuários que podem ingressar na organização com base em seus endereços de e-mail.

    • domainRestrictionEnabled booleano Obrigatório

      O valor que indica se a restrição de domínio está habilitada para esta organização conectada.

    • identityProviderId string

      String 20-hexadecimal legada que identifica o provedor de identidade de acesso à interface do usuário ao qual essa configuração da organização conectada está associada. Esse ID pode ser encontrado na guia Console de gerenciamento federado > aba Provedor de identidade, clicando no ícone de informações na linha IdP ID de um provedor de identidade configurado.

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

    • orgId string Obrigatório

      String exclusiva de 24 caracteres hexadecimais que identifica a configuração da organização conectada.

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

    • postAuthRoleGrants array[string]

      Funções do Atlas que são concedidas a um usuário nessa organização após a autenticação. As funções são um rótulo legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a um usuário específico do MongoDB Cloud. Essas funções só podem ser funções específicas da organização.

      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.

    • roleMappings array[objeto]

      Mapeamentos de role configurados nesta organização.

      Configurações de mapeamento que vinculam um IdP e a nuvem MongoDB .

      Ocultar atributos roleMappings Mostrar atributos roleMappings objeto

      • externalGroupName string Obrigatório

        Rótulo legível único para humanos que identifica o grupo de fornecedores de identidade ao qual esse mapeamento de role se aplica.

        O comprimento mínimo é 1, o comprimento máximo é 200.

      • id string

        String exclusiva de 24dígitos hexadecimais que identifica o mapeamento desse role.

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

      • roleAssignments array[objeto]

        Roles do Atlas e os identificadores exclusivos dos grupos e organizações associados a cada role. A array deve incluir pelo menos um elemento com uma função de organização e seu respectivo orgId. Cada elemento na array pode ter um valor para orgId ou groupId, mas não ambos.

        Ocultar atributos roleAssignments Mostrar atributos roleAssignments objeto

        • groupId string

          24String única de dígitos hexadecimais que identifica o projeto ao qual esta role pertence. Cada elemento em roleAssignments pode ter um valor para groupId ou orgId, mas não para ambos.

          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. Cada elemento em roleAssignments pode ter um valor para orgId ou groupId, mas não para ambos.

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

        • papel 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_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_READ_ONLY, GROUP_BACKUP_MANAGER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATABASE_ACCESS_ADMIN, GROUP_OBSERVABILITY_VIEWER, GROUP_OWNER, GROUP_READ_ONLY, GROUP_SEARCH_INDEX_EDITOR ou GROUP_STREAM_PROCESSING_OWNER.

    • userConflicts array[objeto]

      Lista que contém os usuários com um endereço de e-mail que não corresponde a nenhum domínio na lista de permissões.

      Usuário do MongoDB Cloud vinculado a esta autenticação federada.

      Ocultar atributos userConflicts Mostrar atributos userConflicts objeto

      • emailAddress string(e-mail) Obrigatório

        Endereço de e-mail do usuário da MongoDB Cloud vinculado à organização federada.

      • federationSettingsId string Obrigatório

        String exclusiva de 24dígitos hexadecimais que identifica a federação à qual esse usuário do MongoDB Cloud pertence.

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

      • Nome string Obrigatório

        Nome que pertence ao usuário do MongoDB Cloud.

      • Sobrenome string Obrigatório

        Sobrenome que pertence ao usuário MongoDB Cloud.

      • ID do usuário string

        String única de 24 dígitos hexadecimais que identifica este usuário.

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

  • audienceUri string

    String exclusiva que identifica o público pretendido da afirmação SAML.

  • createdAt string(data-hora)

    Data em que o provedor de identidade foi criado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

  • Descrição string

    A descrição do provedor de identidade.

  • displayName string

    Rótulo legível por humanos que identifica o provedor de identidade.

  • id string Obrigatório

    String única de 24dígitos hexadecimais que identifica o provedor de identidade.

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

  • idpType string

    enumeração de string que indica o tipo do provedor de identidade. O padrão é WORKFORCE.

    Os valores são WORKFORCE ou WORKLOAD.

  • issuerUri string

    String exclusiva que identifica o emissor da SAML Assertion ou metadados OIDC/URL do documento de descoberta.

  • oktaIdpId string Obrigatório

    20-string de dígitos hexadecimais herdado que identifica o provedor de identidade.

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

  • pemFileInfo objeto

    Informações do arquivo PEM para os certificados vigentes do provedor de identidade.

    Hide pemFileInfo attributes Mostrar atributos pemFileInfo objeto

    • Certificados array[objeto]

      Lista de certificados no arquivo.

      Ocultar atributos dos certificados Mostrar atributos de certificados objeto

      • notAfter string(data-hora)

        Data mais recente em que o certificado é válido. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • notBefore string(data-hora)

        Data mais antiga em que o certificado é válido. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • Nome do Arquivo string

      Etiqueta legível por humanos fornecida ao arquivo.

  • protocolo string

    Enumeração de string que indica o protocolo do provedor de identidade. SAML ou OIDC.

    Os valores são SAML ou OIDC.

  • requestBinding string

    Vinculação de método HTTP de Protocolo de Solicitação de Autenticação SAML (POST ou REDIRECT) que a autenticação federada usa para enviar a solicitação de autenticação.

    Os valores são HTTP-POST ou HTTP-REDIRECT.

  • responseSignatureAlgorithm string

    Algoritmo de assinatura que a autenticação federada usa para criptografar a assinatura do provedor de identidade.

    Os valores são SHA-1 ou SHA-256.

  • slug string

    URL de SSO personalizada para o provedor de identidade.

  • ssoDebugEnabled booleano

    Sinalizador que indica se o fornecedor de identidade tem a depuração de SSO habilitada.

  • ssoUrl string

    URL que aponta para o receptor da solicitação de autenticação SAML.

  • Status string

    Enum de string que indica se o provedor de identidade está ativo.

    Os valores são ACTIVE ou INACTIVE.

  • updatedAt string(data-hora)

    Data em que o provedor de identidade foi atualizado pela última vez. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

• 400 aplicação/json

  Solicitação inválida.

  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.

• 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.