Skip to content

certificateauthoritypath-post-mutualtlsoauthconfigurations.md

Latest commit

 

History

History
148 lines (111 loc) · 5.92 KB

certificateauthoritypath-post-mutualtlsoauthconfigurations.md

File metadata and controls

148 lines (111 loc) · 5.92 KB
title Create mutualTlsOauthConfiguration
description Create a mutualTlsOauthConfiguration resource that contains a specified certificate authority object.
author sofia-geislinger
ms.date 12/31/2024
ms.localizationpriority medium
ms.subservice entra-id
doc_type apiPageType

Create mutualTlsOauthConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a mutualTlsOauthConfiguration resource that contains a specified certificate authority object.

[!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-mtlsoauthconfig-apis]

HTTP request

POST /directory/certificateAuthorities/mutualTlsOauthConfigurations

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the mutualTlsOauthConfiguration object.

You can specify the following properties when you create a mutualTlsOauthConfiguration.

Property Type Description
certificateAuthority certificateAuthority collection Multi-value property that represents a list of trusted certificate authorities. Optional.
displayName String Friendly name. Optional.
tlsClientAuthParameter tlsClientRegistrationMetadata Specifies which field in the certificate contains the subject ID. The possible values are: tls_client_auth_subject_dn, tls_client_auth_san_dns, tls_client_auth_san_uri, tls_client_auth_san_ip, tls_client_auth_san_email, unknownFutureValue. Required. Read-only.

Response

If successful, this method returns a 201 Created response code and a mutualTlsOauthConfiguration object in the response body. If a validation failure occurs during the certificate validation steps, the method returns a 400 Bad Request along with the error message, Invalid value specified for property 'certificate' of resource 'CertificateAuthorityInformation'..

For more information, see Microsoft Graph error responses and resource types.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations
Content-Type: application/json

{
  "displayName": "DoorCamera_Model_X_TrustedCAs",
  "tlsClientAuthParameter": "tls_client_auth_san_uri",
  "certificateAuthorities": [
    {
      "@odata.type": "microsoft.graph.certificateAuthority"
    }
  ]
}

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 example shows the response.

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
  "id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
  "displayName": "DoorCamera_Model_X_TrustedCAs",
  "tlsClientAuthParameter": "tls_client_auth_san_uri",
  "certificateAuthorities": [
    {
      "@odata.type": "microsoft.graph.certificateAuthority"
    }
  ]
}