Esquemas de autenticação de ponto de extremidade de serviço

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Saiba como definir as credenciais no cabeçalho de solicitação HTTP ao chamar o ponto de extremidade externo. O Azure DevOps pode se conectar ao serviço externo usando as credenciais. O Azure DevOps dá suporte a um conjunto fechado de esquemas de autenticação utilizados por um tipo de ponto de extremidade de serviço personalizado. O Azure DevOps interpreta o esquema de autenticação usado em qualquer ponto de extremidade personalizado e conexão de suporte ao serviço externo.

Consulte os seguintes esquemas de autenticação que fazem parte do conjunto fechado.

autenticação Básica

Como medida de segurança, é recomendável usar entidades de serviço e identidades gerenciadas por autenticação básica. Para obter mais informações, consulte Usar entidades de serviço e identidades gerenciadas.

Autenticação baseada em token

Esse esquema usa uma entrada – Token de API (confidencial)

O cabeçalho de autenticação padrão usado é: {{endpoint.apitoken}}

{
    "id": "endpoint-auth-scheme-token",
    "description": "i18n:Token based endpoint authentication scheme",
    "type": "ms.vss-endpoint.service-endpoint-type",
    "targets": [
        "ms.vss-endpoint.endpoint-types"
    ],
    "properties": {
        "name": "Token",
        "displayName": "i18n:Token Based Authentication",
        "authenticationSchemes": [
            {
                "type": "ms.vss-endpoint.endpoint-auth-scheme-token",
                "headers": [
                    {
                        "name": "Authorization",
                        "value": "{{endpoint.apitoken}}"
                    }
                ],
                "inputDescriptors": [
                    {
                        "id": "apitoken",
                        "name": "i18n:API Token",
                        "description": "i18n:API Token for connection to endpoint",
                        "inputMode": "textbox",
                        "isConfidential": true,
                        "validation": {
                            "isRequired": true,
                            "dataType": "string",
                            "maxLength": 300
                        }
                    }
                ]
            }
        ]
    }
}

Autenticação baseada em certificado

Esse esquema usa uma entrada – Certificado (confidencial)

O valor do certificado deve ser fornecido na área de texto.

{
    "id": "endpoint-auth-scheme-cert",
    "description": "i18n:Creates a certificate-based endpoint authentication scheme",
    "type": "ms.vss-endpoint.service-endpoint-type",
    "targets": [
        "ms.vss-endpoint.endpoint-types"
    ],
    "properties": {
        "name": "Certificate",
        "displayName": "i18n:Certificate Based",
        "authenticationSchemes": [
            {
                "type": "ms.vss-endpoint.endpoint-auth-scheme-cert",
                "inputDescriptors": [
                    {
                        "id": "certificate",
                        "name": "i18n:Certificate",
                        "description": "Content of the certificate",
                        "inputMode": "TextArea",
                        "isConfidential": true,
                        "validation": {
                            "isRequired": true,
                            "dataType": "string"
                        }
                    }
                ]
            }
        ]
    }
}

Nenhuma autenticação

Esse esquema é usado quando um tipo de endpoint não requer entrada alguma. Por exemplo, serviços externos que dão suporte ao acesso anônimo aos seus recursos.

{
    "id": "endpoint-auth-scheme-none",
    "description": "i18n:Creates an endpoint authentication scheme with no authentication.",
    "type": "ms.vss-endpoint.endpoint-auth-scheme-none",
    "targets": [
        "ms.vss-endpoint.endpoint-auth-schemes"
    ],
    "properties": {
        "name": "None",
        "displayName": "i18n:No Authentication"
    }
}