Schémas d’authentification de point de terminaison de service

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Découvrez comment définir les informations d’identification dans l’en-tête de requête HTTP lorsque vous appelez le point de terminaison externe. Azure DevOps peut ensuite se connecter au service externe à l’aide des informations d’identification. Azure DevOps prend en charge un ensemble fermé de schémas d’authentification utilisés par un type de point de terminaison de service personnalisé. Azure DevOps interprète le schéma d’authentification utilisé dans n’importe quel point de terminaison personnalisé et prend en charge la connexion au service externe.

Consultez les schémas d’authentification suivants qui font partie du jeu fermé.

Conseil

Consultez notre documentation la plus récente sur le développement d’extensions à l’aide du kit de développement logiciel (SDK) d’extension Azure DevOps.

Authentification de base

Par mesure de sécurité, nous recommandons d’utiliser des principaux de service et des identités managées plutôt qu'une authentification de base. Pour plus d’informations, veuillez consulter Utiliser des principaux de service et des identités managées.

Authentification basée sur les jetons

Ce schéma accepte une entrée - Jeton d’API (confidentiel)

L’en-tête d’authentification par défaut utilisé est : {{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
                        }
                    }
                ]
            }
        ]
    }
}

Authentification basée sur un certificat

Ce schéma accepte une entrée - Certificat (confidentiel)

La valeur du certificat doit être fournie dans la zone de texte.

{
    "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"
                        }
                    }
                ]
            }
        ]
    }
}

Aucune authentification

Ce schéma est utilisé lorsqu’un type de point de terminaison ne nécessite aucune entrée. Par exemple, les services externes qui prennent en charge l’accès anonyme à ses ressources.

{
    "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"
    }
}