Update certificateAuthorityDetail

Article
12/23/2024

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a certificateAuthorityDetail object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	❌

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.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	PublicKeyInfrastructure.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	PublicKeyInfrastructure.ReadWrite.All	Not available.

Important

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

Privileged Authentication Administrator
Authentication Administrator

HTTP request

PATCH /directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
certificateAuthorityType	certificateAuthorityType	The type of certificate authority. The possible values are: `root`, `intermediate`, `unknownFutureValue`.
certificate	Binary	The type of certificate authority. Possible values are: `root`, `intermediate`.
displayName	String	The name of the certificate authority.
issuer	String	The issuer of the certificate authority.
issuerSubjectKeyIdentifier	String	The subject key identifier of certificate authority.
createdDateTime	DateTimeOffset	The date and time when the certificate authority was created.
expirationDateTime	DateTimeOffset	The date and time when the certificate authority expires. Required.
thumbprint	String	The thumbprint of certificate authority certificate. Required.
certificateRevocationListUrl	String	The URL to check if the certificate is revoked.
deltacertificateRevocationListUrl	String	The URL to check if the certificate is revoked.
isIssuerHintEnabled	Boolean	Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is `false`.

Response

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

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
Content-Type: application/json

{

   "isIssuerHintEnabled": true
   
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new CertificateAuthorityDetail
{
	IsIssuerHintEnabled = true,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.PublicKeyInfrastructure.CertificateBasedAuthConfigurations["{certificateBasedAuthPki-id}"].CertificateAuthorities["{certificateAuthorityDetail-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta directory public-key-infrastructure certificate-based-auth-configurations certificate-authorities patch --certificate-based-auth-pki-id {certificateBasedAuthPki-id} --certificate-authority-detail-id {certificateAuthorityDetail-id} --body '{\
\
   "isIssuerHintEnabled": true\
   \
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewCertificateAuthorityDetail()
isIssuerHintEnabled := true
requestBody.SetIsIssuerHintEnabled(&isIssuerHintEnabled) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
certificateAuthorities, err := graphClient.Directory().PublicKeyInfrastructure().CertificateBasedAuthConfigurations().ByCertificateBasedAuthPkiId("certificateBasedAuthPki-id").CertificateAuthorities().ByCertificateAuthorityDetailId("certificateAuthorityDetail-id").Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

CertificateAuthorityDetail certificateAuthorityDetail = new CertificateAuthorityDetail();
certificateAuthorityDetail.setIsIssuerHintEnabled(true);
CertificateAuthorityDetail result = graphClient.directory().publicKeyInfrastructure().certificateBasedAuthConfigurations().byCertificateBasedAuthPkiId("{certificateBasedAuthPki-id}").certificateAuthorities().byCertificateAuthorityDetailId("{certificateAuthorityDetail-id}").patch(certificateAuthorityDetail);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const certificateAuthorityDetail = {

   isIssuerHintEnabled: true
   
};

await client.api('/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}')
	.version('beta')
	.update(certificateAuthorityDetail);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CertificateAuthorityDetail;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new CertificateAuthorityDetail();
$requestBody->setIsIssuerHintEnabled(true);

$result = $graphServiceClient->directory()->publicKeyInfrastructure()->certificateBasedAuthConfigurations()->byCertificateBasedAuthPkiId('certificateBasedAuthPki-id')->certificateAuthorities()->byCertificateAuthorityDetailId('certificateAuthorityDetail-id')->patch($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.certificate_authority_detail import CertificateAuthorityDetail
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CertificateAuthorityDetail(
	is_issuer_hint_enabled = True,
)

result = await graph_client.directory.public_key_infrastructure.certificate_based_auth_configurations.by_certificate_based_auth_pki_id('certificateBasedAuthPki-id').certificate_authorities.by_certificate_authority_detail_id('certificateAuthorityDetail-id').patch(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

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

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

{
  "@odata.type": "#microsoft.graph.certificateAuthorityDetail",
  "id": "90777c92-2eb3-4a68-931d-4a3e1e1c741f",
  "deletedDateTime": null,
  "certificateAuthorityType": "root",
  "certificate": "Binary",
  "displayName": "Contoso2 CA1",
  "issuer": "Contoso2",
  "issuerSubjectKeyIdentifier": "C0E9....711A",
  "createdDateTime": "2024-10-25T18:05:28Z",
  "expirationDateTime": "2027-08-29T02:05:57Z",
  "thumbprint": "C6FA....4E9CF2",
  "certificateRevocationListUrl": null,
  "deltacertificateRevocationListUrl": null,
  "isIssuerHintEnabled": true

}

Share via

Update certificateAuthorityDetail

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources