Skip to content

x509certificateauthenticationmethodconfiguration-get.md

Latest commit

 

History

History
142 lines (116 loc) · 5.69 KB

x509certificateauthenticationmethodconfiguration-get.md

File metadata and controls

142 lines (116 loc) · 5.69 KB
title Get x509CertificateAuthenticationMethodConfiguration
description Read the properties and relationships of a x509CertificateAuthenticationMethodConfiguration object.
author vimrang
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 03/10/2025

Get x509CertificateAuthenticationMethodConfiguration

Namespace: microsoft.graph

Read the configuration details for the X.509 certificate authentication method in the authentication methods policy.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-policy-apis-read]

HTTP request

GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x509Certificate

Optional query parameters

This method does not support the OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a x509CertificateAuthenticationMethodConfiguration object in the response body.

Examples

Request

HTTP

GET https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/x509Certificate

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following response object shows an x509CertificateAuthenticationMethodConfiguration with its default configuration.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#authenticationMethodConfigurations/$entity",
    "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration",
    "id": "X509Certificate",
    "state": "disabled",
    "certificateUserBindings": [
        {
            "x509CertificateField": "PrincipalName",
            "userProperty": "onPremisesUserPrincipalName",
            "priority": 1
        },
        {
            "x509CertificateField": "RFC822Name",
            "userProperty": "userPrincipalName",
            "priority": 2
        }
    ],
    "authenticationModeConfiguration": {
        "x509CertificateAuthenticationDefaultMode": "x509CertificateSingleFactor",
        "rules": []
    },
    "crlValidationConfiguration": {
        "state": "disabled",
        "exemptedCertificateAuthoritiesSubjectKeyIdentifiers": []
    },
    "includeTargets": [
        {
            "targetType": "group",
            "id": "all_users",
            "isRegistrationRequired": false
        }
    ],
    "excludeTargets": []
}