Skip to content

certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md

Latest commit

 

History

History
152 lines (112 loc) · 5.7 KB

certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md

File metadata and controls

152 lines (112 loc) · 5.7 KB
title Create certificateBasedAuthConfiguration
description Use this API to create a new certificateBasedAuthConfiguration.
ms.localizationpriority medium
author vimrang
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 04/05/2024
ms.custom sfi-ga-nochange

Create certificateBasedAuthConfiguration

Namespace: microsoft.graph

Create a new certificateBasedAuthConfiguration object.

Note

Only a single instance of a certificateBasedAuthConfiguration can be created (the collection can only have one member). It always has a fixed ID with a value of '29728ade-6ae4-4ee9-9103-412912537da5'.

[!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-cert-based-auth-config-apis]

HTTP request

POST /organization/{id}/certificateBasedAuthConfiguration

Request headers

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

Request body

The following properties are required to create the certificateBasedAuthConfiguration object.

Property Type Description
certificateAuthorities certificateAuthority collection Collection of certificate authorities that creates a trusted certificate chain. Each member of the collection must contain certificate and isRootAuthority properties.

Response

If successful, this method returns 201 Created response code and a new certificateBasedAuthConfiguration object in the response body.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/organization/{id}/certificateBasedAuthConfiguration
Content-type: application/json

{
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificate": "Binary"
    }
  ]
}

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

{
  "id": "id-value",
  "certificateAuthorities": [
    {
      "isRootAuthority": true,
      "certificate": "Binary",
      "issuer": "issuer-value",
      "issuerSki": "issuerSki-value"
    }
  ]
}