Criar samlOrWsFedExternalDomainFederation

Namespace: microsoft.graph

Crie um novo objeto samlOrWsFedExternalDomainFederation .

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegada (conta corporativa ou de estudante)	IdentityProvider.ReadWrite.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	IdentityProvider.ReadWrite.All	Indisponível.

A conta de trabalho ou de estudante precisa pertencer ao menos à função Administrador do Provedor de Identidade ExternaMicrosoft Entra função.

Solicitação HTTP

POST /directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto samlOrWsFedExternalDomainFederation .

A tabela a seguir lista as propriedades necessárias ao criar o samlOrWsFedExternalDomainFederation.

Propriedade	Tipo	Descrição
displayName	Cadeia de caracteres	O nome de exibição do provedor de identidade baseado em SAML/WS-Fed. Herdado de identityProviderBase.
issuerUri	Cadeia de caracteres	URI do emissor do servidor de federação. Herdado de samlOrWsFedProvider.
metadadosExchangeUri	Cadeia de caracteres	URI do ponto de extremidade de troca de metadados usado para autenticação de aplicativos cliente avançados. Herdado de samlOrWsFedProvider.
passiveSignInUri	Cadeia de caracteres	URI ao qual os clientes baseados na Web são direcionados ao entrar nos serviços de Microsoft Entra. Herdado de samlOrWsFedProvider.
preferredAuthenticationProtocol	authenticationProtocol	Protocolo de autenticação preferencial. Os valores possíveis são: wsFed, saml. Herdado de samlOrWsFedProvider.
signingCertificate	Cadeia de caracteres	Certificado atual usado para assinar tokens passados para o plataforma de identidade da Microsoft. O certificado é formatado como uma cadeia de caracteres codificada base64 da parte pública do certificado de assinatura de token do IdP federado e deve ser compatível com a classe X509Certificate2. Essa propriedade é usada nos seguintes cenários: se uma rolagem for necessária fora da atualização de rolagem automática um novo serviço de federação está sendo configurado se o novo certificado de assinatura de token não estiver presente nas propriedades de federação após a atualização do certificado de serviço de federação. Microsoft Entra ID atualiza certificados por meio de um processo de autorollover no qual tenta recuperar um novo certificado dos metadados do serviço de federação, 30 dias antes do término do certificado atual. Se um novo certificado não estiver disponível, Microsoft Entra ID monitorará os metadados diariamente e atualizará as configurações de federação para o domínio quando um novo certificado estiver disponível.

Resposta

Se for bem-sucedido, esse método retornará um 201 Created código de resposta e um objeto samlOrWsFedExternalDomainFederation no corpo da resposta.

Exemplos

Solicitação

HTTP

POST https://graph.microsoft.com/beta/directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation
Content-Type: application/json

{
    "@odata.type": "microsoft.graph.samlOrWsFedExternalDomainFederation",
    "issuerUri": "https://contoso.com/issuerUri",
    "displayName": "contoso display name",
    "metadataExchangeUri": "https://contoso.com/metadataExchangeUri",
    "passiveSignInUri": "https://contoso.com/signin",
    "preferredAuthenticationProtocol": "wsFed",
    "domains": [
        {
            "@odata.type": "microsoft.graph.externalDomainName",
            "id": "contoso.com"
        }
    ],
    "signingCertificate": "MIIDADCCAeigAwIBAgIQEX41y8r6"
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const samlOrWsFedExternalDomainFederation = {
    '@odata.type': 'microsoft.graph.samlOrWsFedExternalDomainFederation',
    issuerUri: 'https://contoso.com/issuerUri',
    displayName: 'contoso display name',
    metadataExchangeUri: 'https://contoso.com/metadataExchangeUri',
    passiveSignInUri: 'https://contoso.com/signin',
    preferredAuthenticationProtocol: 'wsFed',
    domains: [
        {
            '@odata.type': 'microsoft.graph.externalDomainName',
            id: 'contoso.com'
        }
    ],
    signingCertificate: 'MIIDADCCAeigAwIBAgIQEX41y8r6'
};

await client.api('/directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation')
	.version('beta')
	.post(samlOrWsFedExternalDomainFederation);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": "3c41f317-9af3-4266-8ccf-26283ceec888",
    "displayName": "contoso display name"
}