- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
Crie um provedor de identidade OIDC.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça comentários em https://feedback.mongodb.com/forums/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Sintaxe
atlas federatedAuthentication federationSettings identityProvider create oidc [displayName] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
displayName | string | false | O nome de exibição do fornecedor de identidade. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--associatedDomain | strings | false | Lista de domínios associados ao provedor de identidade. |
--audience | string | true | Identificador do destinatário pretendido do token. |
--authorizationType | string | true | Tipo de autorização. Os valores válidos são GROUP ou USER. |
--clientId | string | false | Identificador do cliente atribuído a um aplicativo pelo fornecedor de identidade. |
--desc | string | true | Descrição do fornecedor de identidade. |
--federationSettingsId | string | true | string exclusiva de 24dígitos hexadecimais que identifica as configurações de federação. |
--groupsClaim | string | true | Identificador da declaração que contém IDs do Grupo de IdP no token. |
-h, --help | false | ajuda para oidc | |
--idpType | string | true | Tipo de provedor de identidade. Os valores válidos são WORKFORCE ou WORKLOAD. |
--issuerUri | string | true | string exclusiva que identifica o emissor dos metadados OIDC/ URL do documento de descoberta . |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--requestedScope | strings | false | Escopos que os aplicativos MongoDB solicitarão no endpoint de autorização. |
--userClaim | string | true | Identificador da declaração que contém o ID do usuário no token. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Identity provider '<Id>' created.
Exemplos
# Create an identity provider with name IDPName and from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa. atlas federatedAuthentication federationSettings identityProvider create oidc IDPName --audience "audience" --authorizationType "GROUP" --clientId clientId --desc "IDPName test" --federationSettingsId "5d1113b25a115342acc2d1aa" --groupsClaim "groups" --idpType "WORKLOAD" --issuerUri uri" --userClaim "user" --associatedDomain "domain"