Recuperar informações sobre o fornecedor de autenticação

OBTER /groups/{groupId}/apps/{appId}/auth_providers/{providerId}

tokenAuth

Recupere informações sobre um dos fornecedores de autenticação de um aplicativo.

parâmetros de caminho

groupId string Obrigatório

Uma ID de projeto/grupo do Atlas.
appId string Obrigatório

O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.
providerId string Obrigatório

O valor _id único de um fornecedor de autenticação

Respostas

200 aplicação/json

Recuperado com sucesso.
Qualquer um dos seguintes:
objeto AnonymousAuthProvider objeto EmailPasswordAuthProvider objeto ApiKeyAuthProvider objeto CustomJwtAuthProvider objeto CustomFunctionAuthProvider objeto AppleAuthProvider objeto GoogleAuthProvider objeto FacebookAuthProvider
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do fornecedor de autenticação. Para uma autenticação anônima, este valor é sempre anon-user.

O valor é anon-user.

type string Obrigatório

O nome do fornecedor de autenticação. Para uma autenticação anônima, este valor é sempre anon-user.

O valor é anon-user.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para autenticação de e-mail/senha, este valor é sempre local-userpass.

O valor é local-userpass.

type string Obrigatório

O nome do provedor de autenticação. Para autenticação de e-mail/senha, este valor é sempre local-userpass.

O valor é local-userpass.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.

config objeto

Um dos seguintes:
objeto SenhaRefreshBuiltIn objeto SenhaRefreshCustomFunction objeto SenhaRefreshBuiltIn objeto SenhaRefreshCustomFunction objeto SenhaRefreshBuiltIn objeto SenhaRefreshCustomFunction

Ocultar atributos Mostrar atributos

autoConfirm

Se true, confirme automaticamente novas contas de usuário sem verificação adicional.

O valor é true.

resetPasswordUrl string

A URL incluída no e-mail enviado aos usuários como parte do fluxo de redefinição de senha integrado. O e-mail também adiciona uma redefinição de senha exclusiva token e tokenId como parâmetros de consulta.

Essa URL deve lidar com a confirmação do usuário passando o token de redefinição de senha para a função resetPassword do Realm SDK.

RedefinirPasswordSubject string

A linha de assunto do e-mail enviado aos usuários como parte do fluxo de redefinição de senha integrado.

Ocultar atributos Mostrar atributos

autoConfirm

Se true, confirme automaticamente novas contas de usuário sem verificação adicional.

O valor é true.

função de execução booleano

Se true, use uma função personalizada que você define para lidar com o processo de redefinição de senha.

O valor é true.

resetFunctionName string

O nome da função personalizada que lida com o processo de redefinição de senha.

Ocultar atributos Mostrar atributos

autoConfirm

Se true, confirme automaticamente novas contas de usuário sem verificação adicional. Para confirmar a conta de e-mail incorporada, defina esse valor como false.

O valor é false.

emailConfirmationUrl string

A URL incluída no e-mail enviado a novos usuários como parte do fluxo de confirmação integrado. O e-mail também adiciona uma confirmação exclusiva token e tokenId como parâmetros de consulta.

Esse URL deve lidar com a confirmação do usuário passando o token de confirmação para a função confirmUser do Realm SDK ou para o endpoint da API de administrador confirmar um usuário de e-mail/senha pendente.

confirmEmailSubject string

A linha de assunto do e-mail enviado para novos usuários como parte do fluxo de confirmação integrado.

resetPasswordUrl string

A URL incluída no e-mail enviado aos usuários como parte do fluxo de redefinição de senha integrado. O e-mail também adiciona uma redefinição de senha exclusiva token e tokenId como parâmetros de consulta.

Essa URL deve lidar com a confirmação do usuário passando o token de redefinição de senha para a função resetPassword do Realm SDK.

RedefinirPasswordSubject string

A linha de assunto do e-mail enviado aos usuários como parte do fluxo de redefinição de senha integrado.

Ocultar atributos Mostrar atributos

autoConfirm

Se true, confirme automaticamente novas contas de usuário sem verificação adicional. Para confirmar a conta de e-mail incorporada, defina esse valor como false.

O valor é false.

emailConfirmationUrl string

A URL incluída no e-mail enviado a novos usuários como parte do fluxo de confirmação integrado. O e-mail também adiciona uma confirmação exclusiva token e tokenId como parâmetros de consulta.

Esse URL deve lidar com a confirmação do usuário passando o token de confirmação para a função confirmUser do Realm SDK ou para o endpoint da API de administrador confirmar um usuário de e-mail/senha pendente.

confirmEmailSubject string

A linha de assunto do e-mail enviado para novos usuários como parte do fluxo de confirmação integrado.

função de execução booleano

Se true, use uma função personalizada que você define para lidar com o processo de redefinição de senha.

O valor é true.

resetFunctionName string

O nome da função personalizada que lida com o processo de redefinição de senha.

Ocultar atributos Mostrar atributos

autoConfirm

Se true, confirme automaticamente novas contas de usuário sem verificação adicional. Para a confirmação da conta de função personalizada, defina este valor como false.

O valor é false.

runConfirmationFunction booleano

Se true, os novos registros de conta de usuário de e-mail/senha usam uma função personalizada que você define para lidar com o processo de confirmação.

confirmFunctionName string

O nome da função personalizada que lida com o processo de confirmação.

resetPasswordUrl string

A URL incluída no e-mail enviado aos usuários como parte do fluxo de redefinição de senha integrado. O e-mail também adiciona uma redefinição de senha exclusiva token e tokenId como parâmetros de consulta.

Essa URL deve lidar com a confirmação do usuário passando o token de redefinição de senha para a função resetPassword do Realm SDK.

RedefinirPasswordSubject string

A linha de assunto do e-mail enviado aos usuários como parte do fluxo de redefinição de senha integrado.

Ocultar atributos Mostrar atributos

autoConfirm

Se true, confirme automaticamente novas contas de usuário sem verificação adicional. Para a confirmação da conta de função personalizada, defina este valor como false.

O valor é false.

runConfirmationFunction booleano

Se true, os novos registros de conta de usuário de e-mail/senha usam uma função personalizada que você define para lidar com o processo de confirmação.

confirmFunctionName string

O nome da função personalizada que lida com o processo de confirmação.

função de execução booleano

Se true, use uma função personalizada que você define para lidar com o processo de redefinição de senha.

O valor é true.

resetFunctionName string

O nome da função personalizada que lida com o processo de redefinição de senha.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para autenticação de chave API, esse valor é sempre api-key.

O valor é api-key.

type string Obrigatório

O nome do provedor de autenticação. Para autenticação de chave API, esse valor é sempre api-key.

O valor é api-key.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para uma autenticação de JSON web token personalizada, esse valor é sempre custom-token.

O valor é custom-token.

type string Obrigatório

O nome do provedor de autenticação. Para uma autenticação de JSON web token personalizada, esse valor é sempre custom-token.

O valor é custom-token.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.

config objeto

Um objeto de configuração para o provedor de autenticação do token da web JSON personalizado.

Ocultar atributos de configuração Mostrar atributos de configuração objeto

Público array[string]

Define os valores esperados da declaração aud no token web JSON externo. Por padrão, o fornecedor de token da web JSON personalizado espera que aud seja sua ID do aplicativo.

requireAnyAudience string

Se false, o token web JSON externo deve incluir todos os valores definidos em audience em sua reivindicação aud.

Se true, um JSON web token será válido se qualquer um dos valores definidos em audience estiver em sua reivindicação aud.

O valor padrão é false.

signatureAlgorithm string

O método criptográfico que o sistema externo usa para assinar o JSON web token. A autenticação de token da Web JSON personalizado suporta JWTs assinados usando qualquer um dos seguintes algoritmos:

HS256

RS256

useJWKURI booleano

Se true, o fornecedor de token da Web JSON personalizado usa um algoritmo de assinatura e chaves de assinatura definidas em uma JSON Web Key (JWK) ou JSON Web Key Set (JWKS). O(S) JWK(S) deve(m) estar acessível(s) na URL especificada em jwkURI.

jwkURI string

Uma URL que hospeda um JWK ou JWKS que descreve o método de assinatura e as chaves de assinatura que o fornecedor de token da web JSON personalizado deve usar. O(S) JWK(S) pode especificar até três chaves de assinatura e deve usar o algoritmo RS256.

secret_config objeto

Ocultar atributo secret_config Mostrar atributo secret_config objeto

chaves de assinatura array[string]

Uma lista dos nomes de até três segredos cada um contendo uma chave de assinatura usada pelo sistema de autenticação externo para assinar JWTs. O segredo de cada chave de assinatura deve ser uma string com comprimento entre 32 e 512 caracteres.

metadata_fields array[objeto]

Os campos de metadados são dados adicionais que descrevem cada usuário. O valor de cada campo de metadados vem de algum campo incluído no JSON web token do sistema de autenticação externo.

Os campos de metadados de um usuário são atualizados sempre que ele faz login.

Um campo de metadados específico do JSON web token externo para incluir os dados do usuário. Mapeia um nome de campo de token da web JSON externo (name) para o nome de campo nos dados do usuário (field_name) que contém o valor desse campo.

Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields objeto

necessário booleano

Se true, esse valor deverá estar sempre presente no JSON web token externo.

name string

O nome do campo no JSON web token externo que contém os dados.

Para especificar um campo em um objeto incorporado, use a notação de ponto.

field_name string

O nome do campo no objeto de usuário que contém o valor.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para a autenticação de função personalizada, esse valor é sempre custom-function.

O valor é custom-function.

type string Obrigatório

O nome do provedor de autenticação. Para a autenticação de função personalizada, esse valor é sempre custom-function.

O valor é custom-function.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.

config objeto

Um objeto de configuração para o provedor de autenticação de Função Personalizada .

Ocultar atributo de configuração Mostrar atributo de configuração objeto

authFunctionName string

O nome da função de autenticação personalizada que lida com logins de usuário.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para autenticação da Apple, este valor é sempre oauth2-apple.

O valor é oauth2-apple.

type string Obrigatório

O nome do provedor de autenticação. Para autenticação da Apple, este valor é sempre oauth2-apple.

O valor é oauth2-apple.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.

config objeto

Um objeto de configuração para o provedor de autenticação da Apple.

Ocultar atributo de configuração Mostrar atributo de configuração objeto

ID do cliente string

Seu ID de serviços da Apple.

Para saber como obter isso, consulte Criar uma ID de serviços.

secret_config objeto

Ocultar atributo secret_config Mostrar atributo secret_config objeto

clientSecret string

O nome de um segredo que contém o JSON web token do segredo do cliente.

Para saber como criar isso, consulte Criar o web token JSON do segredo do cliente.

redirect_uris array[string]

Uma lista de URIs para os quais o fluxo OAuth deve permitir que o usuário redirecione.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para autenticação do Google, este valor é sempre oauth2-google.

O valor é oauth2-google.

type string Obrigatório

O nome do provedor de autenticação. Para autenticação do Google, este valor é sempre oauth2-google.

O valor é oauth2-google.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.

config objeto

Um objeto de configuração para o provedor de autenticação do Google .

Ocultar atributos de configuração Mostrar atributos de configuração objeto

ID do cliente string

Um OAuth 2.0 ID do cliente para seu projeto GCP.

Para saber como criar um, consulte Configurar um projeto no console da API do Google.

openId booleano

An OAuth 2.0

secret_config objeto

Ocultar atributo secret_config Mostrar atributo secret_config objeto

clientSecret string

O nome de um segredo que contém o OAuth 2.0 Segredo do cliente para o ID do cliente especificado em config.clientId.

redirect_uris array[string]

Uma lista de URIs para os quais o fluxo OAuth deve permitir que o usuário redirecione.

metadata_fields array[array]

Os campos de metadados são dados adicionais que descrevem cada usuário. O valor de cada campo de metadados vem do Google e está incluído no JSON web token autenticado.

Os campos de metadados de um usuário são atualizados sempre que ele faz login.

Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields objeto

necessário booleano

Se true, inclua este valor de metadados no token da web OAuth JSON e nos dados do usuário.

name string

O nome de uma propriedade de metadados do usuário acessível por OAuth, por exemplo email.

domain_restrictions array[string]

Uma lista de nomes de domínio aprovados para contas de usuário. Se isso for definido, o usuário deverá ter um endereço de e-mail associado ao perfil OAuth que tenha um domínio incluído nessa lista.
Ocultar atributos Mostrar atributos

_id string

O ID único do fornecedor de autenticação.

name string Obrigatório

O nome do provedor de autenticação. Para autenticação do Facebook, este valor é sempre oauth2-facebook.

O valor é oauth2-facebook.

type string Obrigatório

O nome do provedor de autenticação. Para autenticação do Facebook, este valor é sempre oauth2-facebook.

O valor é oauth2-facebook.

desabilitado booleano

Se true, o fornecedor de autenticação estará desabilitado. Os usuários não podem fazer login por meio do fornecedor até que ele seja ativado.

config objeto

Um objeto de configuração para o provedor de autenticação do Facebook.

Ocultar atributo de configuração Mostrar atributo de configuração objeto

ID do cliente string

A ID do aplicativo do seu aplicativo do Facebook.

secret_config objeto

Ocultar atributo secret_config Mostrar atributo secret_config objeto

clientSecret string

O nome de um segredo que contém o segredo do seu aplicativo do Facebook.

redirect_uris array[string]

Uma lista de URIs para os quais o fluxo OAuth deve permitir que o usuário redirecione.

metadata_fields array[array]

Os campos de metadados são dados adicionais que descrevem cada usuário. O valor de cada campo de metadados vem do Facebook e está incluído no JSON web token autenticado.

Os campos de metadados de um usuário são atualizados sempre que ele faz login.

Ocultar atributos de metadata_fields Mostrar atributos de metadata_fields objeto

necessário booleano

Se true, inclua este valor de metadados no token da web OAuth JSON e nos dados do usuário.

name string

O nome de uma propriedade de metadados do usuário acessível por OAuth, por exemplo email.

domain_restrictions array[string]

Uma lista de nomes de domínio aprovados para contas de usuário. Se isso for definido, o usuário deverá ter um endereço de e-mail associado ao perfil OAuth que tenha um domínio incluído nessa lista.

GET /groups/{groupId}/apps/{appId}/auth_providers/{providerId}

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Exemplos de resposta (200)

{
  "_id": "string",
  "name": "anon-user",
  "type": "anon-user",
  "disabled": true
}

{
  "_id": "string",
  "name": "local-userpass",
  "type": "local-userpass",
  "disabled": true,
  "config": {
    "autoConfirm": true,
    "resetPasswordUrl": "string",
    "resetPasswordSubject": "string"
  }
}

{
  "_id": "string",
  "name": "api-key",
  "type": "api-key",
  "disabled": true
}

{
  "_id": "string",
  "name": "custom-token",
  "type": "custom-token",
  "disabled": true,
  "config": {
    "audience": [
      "string"
    ],
    "requireAnyAudience": false,
    "signingAlgorithm": "string",
    "useJWKURI": true,
    "jwkURI": "string"
  },
  "secret_config": {
    "signingKeys": [
      "string"
    ]
  },
  "metadata_fields": [
    {
      "required": true,
      "name": "string",
      "field_name": "string"
    }
  ]
}

{
  "_id": "string",
  "name": "custom-function",
  "type": "custom-function",
  "disabled": true,
  "config": {
    "authFunctionName": "string"
  }
}

{
  "_id": "string",
  "name": "oauth2-apple",
  "type": "oauth2-apple",
  "disabled": true,
  "config": {
    "clientId": "string"
  },
  "secret_config": {
    "clientSecret": "string"
  },
  "redirect_uris": [
    "string"
  ]
}

{
  "_id": "string",
  "name": "oauth2-google",
  "type": "oauth2-google",
  "disabled": true,
  "config": {
    "clientId": "string",
    "openId": true
  },
  "secret_config": {
    "clientSecret": "string"
  },
  "redirect_uris": [
    "string"
  ],
  "metadata_fields": [
    [
      {
        "required": true,
        "name": "string"
      }
    ]
  ],
  "domain_restrictions": [
    "string"
  ]
}

{
  "_id": "string",
  "name": "oauth2-facebook",
  "type": "oauth2-facebook",
  "disabled": true,
  "config": {
    "clientId": "string"
  },
  "secret_config": {
    "clientSecret": "string"
  },
  "redirect_uris": [
    "string"
  ],
  "metadata_fields": [
    [
      {
        "required": true,
        "name": "string"
      }
    ]
  ],
  "domain_restrictions": [
    "string"
  ]
}