命名空间:microsoft.graph
创建新的 certificateBasedAuthConfiguration 对象。
注意
只能创建 certificateBasedAuthConfiguration 的单个实例, (集合只能有一个成员) 。 它始终具有值为“29728ade-6ae4-4ee9-9103-412912537da5”的固定 ID。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
Organization.ReadWrite.All |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
Organization.ReadWrite.All |
不可用。 |
重要
在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。
全局管理员 是此操作唯一支持的角色。
HTTP 请求
POST /organization/{id}/certificateBasedAuthConfiguration
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
创建 certificateBasedAuthConfiguration 对象需要以下属性。
属性 |
类型 |
说明 |
certificateAuthorities |
certificateAuthority 集合 |
创建受信任证书链的证书颁发机构的集合。 集合的每个成员都必须包含 证书 和 isRootAuthority 属性。 |
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和新的 certificateBasedAuthConfiguration 对象。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/organization/{id}/certificateBasedAuthConfiguration
Content-type: application/json
{
"certificateAuthorities": [
{
"isRootAuthority": true,
"certificate": "Binary"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new CertificateBasedAuthConfiguration
{
CertificateAuthorities = new List<CertificateAuthority>
{
new CertificateAuthority
{
IsRootAuthority = true,
Certificate = Convert.FromBase64String("Binary"),
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].CertificateBasedAuthConfiguration.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc organization certificate-based-auth-configuration create --organization-id {organization-id} --body '{\
"certificateAuthorities": [\
{\
"isRootAuthority": true,\
"certificate": "Binary"\
}\
]\
}\
'
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewCertificateBasedAuthConfiguration()
certificateAuthority := graphmodels.NewCertificateAuthority()
isRootAuthority := true
certificateAuthority.SetIsRootAuthority(&isRootAuthority)
certificate := []byte("binary")
certificateAuthority.SetCertificate(&certificate)
certificateAuthorities := []graphmodels.CertificateAuthorityable {
certificateAuthority,
}
requestBody.SetCertificateAuthorities(certificateAuthorities)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
certificateBasedAuthConfiguration, err := graphClient.Organization().ByOrganizationId("organization-id").CertificateBasedAuthConfiguration().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CertificateBasedAuthConfiguration certificateBasedAuthConfiguration = new CertificateBasedAuthConfiguration();
LinkedList<CertificateAuthority> certificateAuthorities = new LinkedList<CertificateAuthority>();
CertificateAuthority certificateAuthority = new CertificateAuthority();
certificateAuthority.setIsRootAuthority(true);
byte[] certificate = Base64.getDecoder().decode("Binary");
certificateAuthority.setCertificate(certificate);
certificateAuthorities.add(certificateAuthority);
certificateBasedAuthConfiguration.setCertificateAuthorities(certificateAuthorities);
CertificateBasedAuthConfiguration result = graphClient.organization().byOrganizationId("{organization-id}").certificateBasedAuthConfiguration().post(certificateBasedAuthConfiguration);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const certificateBasedAuthConfiguration = {
certificateAuthorities: [
{
isRootAuthority: true,
certificate: 'Binary'
}
]
};
await client.api('/organization/{id}/certificateBasedAuthConfiguration')
.post(certificateBasedAuthConfiguration);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\CertificateBasedAuthConfiguration;
use Microsoft\Graph\Generated\Models\CertificateAuthority;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CertificateBasedAuthConfiguration();
$certificateAuthoritiesCertificateAuthority1 = new CertificateAuthority();
$certificateAuthoritiesCertificateAuthority1->setIsRootAuthority(true);
$certificateAuthoritiesCertificateAuthority1->setCertificate(\GuzzleHttp\Psr7\Utils::streamFor(base64_decode('Binary')));
$certificateAuthoritiesArray []= $certificateAuthoritiesCertificateAuthority1;
$requestBody->setCertificateAuthorities($certificateAuthoritiesArray);
$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->certificateBasedAuthConfiguration()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
certificateAuthorities = @(
@{
isRootAuthority = $true
certificate = [System.Text.Encoding]::ASCII.GetBytes("Binary")
}
)
}
New-MgOrganizationCertificateBasedAuthConfiguration -OrganizationId $organizationId -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.certificate_based_auth_configuration import CertificateBasedAuthConfiguration
from msgraph.generated.models.certificate_authority import CertificateAuthority
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CertificateBasedAuthConfiguration(
certificate_authorities = [
CertificateAuthority(
is_root_authority = True,
certificate = base64.urlsafe_b64decode("Binary"),
),
],
)
result = await graph_client.organization.by_organization_id('organization-id').certificate_based_auth_configuration.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-type: application/json
{
"id": "id-value",
"certificateAuthorities": [
{
"isRootAuthority": true,
"certificate": "Binary",
"issuer": "issuer-value",
"issuerSki": "issuerSki-value"
}
]
}