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.
Create a new trusted certificate authority in a certificateBasedApplicationConfiguration 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) |
AppCertTrustConfiguration.Read.All |
AppCertTrustConfiguration.ReadWrite.All |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
AppCertTrustConfiguration.Read.All |
AppCertTrustConfiguration.ReadWrite.All |
Important
In delegated scenarios with work or school accounts, the signed-in user 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.
- Application Administrator
- Cloud Application Administrator
HTTP request
POST /directory/certificateAuthorities/certificateBasedApplicationConfigurations/{certificateBasedApplicationConfigurationId}/trustedCertificateAuthorities
Request body
In the request body, supply a JSON representation of the certificateAuthorityAsEntity object.
You can specify the following properties when you create a certificateAuthorityAsEntity.
Note: A maximum of 10 trusted authorities are allowed per trustedCertificateAuthorities collection.
Property |
Type |
Description |
certificate |
Binary |
The trusted certificate. Required. |
isRootAuthority |
Boolean |
Indicates if the certificate is a root authority. Required. Only one object in a trustedCertificateAuthorities collection can be the root authority. |
issuer |
String |
The issuer of the trusted certificate. Required. |
issuerSubjectKeyIdentifier |
String |
The subject key identifier of the trusted certificate. Required. |
Response
If successful, this method returns a 201 Created
response code and a certificateAuthorityAsEntity object in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities
Content-Type: application/json
{
"isRootAuthority": true,
"certificate": "MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....",
"issuer": "ExampleIssuer",
"issuerSubjectKeyIdentifier": " BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new CertificateAuthorityAsEntity
{
IsRootAuthority = true,
Certificate = Convert.FromBase64String("MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB...."),
Issuer = "ExampleIssuer",
IssuerSubjectKeyIdentifier = " BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.CertificateAuthorities.CertificateBasedApplicationConfigurations["{certificateBasedApplicationConfiguration-id}"].TrustedCertificateAuthorities.PostAsync(requestBody);
mgc-beta directory certificate-authorities certificate-based-application-configurations trusted-certificate-authorities create --certificate-based-application-configuration-id {certificateBasedApplicationConfiguration-id} --body '{\
"isRootAuthority": true,\
"certificate": "MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....",\
"issuer": "ExampleIssuer",\
"issuerSubjectKeyIdentifier": " BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9"\
}\
'
// 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.NewCertificateAuthorityAsEntity()
isRootAuthority := true
requestBody.SetIsRootAuthority(&isRootAuthority)
certificate := []byte("mIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....")
requestBody.SetCertificate(&certificate)
issuer := "ExampleIssuer"
requestBody.SetIssuer(&issuer)
issuerSubjectKeyIdentifier := " BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9"
requestBody.SetIssuerSubjectKeyIdentifier(&issuerSubjectKeyIdentifier)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
trustedCertificateAuthorities, err := graphClient.Directory().CertificateAuthorities().CertificateBasedApplicationConfigurations().ByCertificateBasedApplicationConfigurationId("certificateBasedApplicationConfiguration-id").TrustedCertificateAuthorities().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CertificateAuthorityAsEntity certificateAuthorityAsEntity = new CertificateAuthorityAsEntity();
certificateAuthorityAsEntity.setIsRootAuthority(true);
byte[] certificate = Base64.getDecoder().decode("MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....");
certificateAuthorityAsEntity.setCertificate(certificate);
certificateAuthorityAsEntity.setIssuer("ExampleIssuer");
certificateAuthorityAsEntity.setIssuerSubjectKeyIdentifier(" BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9");
CertificateAuthorityAsEntity result = graphClient.directory().certificateAuthorities().certificateBasedApplicationConfigurations().byCertificateBasedApplicationConfigurationId("{certificateBasedApplicationConfiguration-id}").trustedCertificateAuthorities().post(certificateAuthorityAsEntity);
const options = {
authProvider,
};
const client = Client.init(options);
const certificateAuthorityAsEntity = {
isRootAuthority: true,
certificate: 'MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....',
issuer: 'ExampleIssuer',
issuerSubjectKeyIdentifier: ' BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9'
};
await client.api('/directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities')
.version('beta')
.post(certificateAuthorityAsEntity);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CertificateAuthorityAsEntity;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CertificateAuthorityAsEntity();
$requestBody->setIsRootAuthority(true);
$requestBody->setCertificate(\GuzzleHttp\Psr7\Utils::streamFor(base64_decode('MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....')));
$requestBody->setIssuer('ExampleIssuer');
$requestBody->setIssuerSubjectKeyIdentifier(' BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9');
$result = $graphServiceClient->directory()->certificateAuthorities()->certificateBasedApplicationConfigurations()->byCertificateBasedApplicationConfigurationId('certificateBasedApplicationConfiguration-id')->trustedCertificateAuthorities()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
isRootAuthority = $true
certificate = [System.Text.Encoding]::ASCII.GetBytes("MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB....")
issuer = "ExampleIssuer"
issuerSubjectKeyIdentifier = " BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9"
}
New-MgBetaDirectoryCertificateAuthorityCertificateBasedApplicationConfigurationTrustedCertificateAuthority -CertificateBasedApplicationConfigurationId $certificateBasedApplicationConfigurationId -BodyParameter $params
# 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_as_entity import CertificateAuthorityAsEntity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CertificateAuthorityAsEntity(
is_root_authority = True,
certificate = base64.urlsafe_b64decode("MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB...."),
issuer = "ExampleIssuer",
issuer_subject_key_identifier = " BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9",
)
result = await graph_client.directory.certificate_authorities.certificate_based_application_configurations.by_certificate_based_application_configuration_id('certificateBasedApplicationConfiguration-id').trusted_certificate_authorities.post(request_body)
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.type": "#microsoft.graph.certificateAuthorityAsEntity",
"certificate": "MIIGrDCCBJSgAwIBAgITWgACAdWQXvWynRA6/AABAAIB",
"id": "b505a013-aebd-2dea-e9ec-a506fbde61d3",
"issuer": "ExampleIssuer",
"issuerSubjectKeyIdentifier": "BA:AF:4A:02:4D:AA:A6:F1:3C:25:8E:AD:FA:38:98:CE:D9:23:32:D9",
"isRootAuthority": true
}