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.
Upload a certificate to a trustFrameworkKeyset. The input is a base-64 encoded value of the certificate contents. This method returns trustFrameworkKey.
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) |
TrustFrameworkKeySet.ReadWrite.All |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
TrustFrameworkKeySet.ReadWrite.All |
Not available. |
Important
In delegated scenarios with work or school accounts, the admin must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. B2C IEF Keyset Administrator is the least privileged role supported for this operation.
HTTP request
POST /trustFramework/keySets/{id}/uploadCertificate
Request body
In the request body, provide a JSON object with the following parameters.
Parameter |
Type |
Description |
key |
String |
This is the field for sending certificate content. The value should be a base-64 encoded version of the actual certificate content. |
Response
If successful, this method returns a 200 OK
response code and a new trustFrameworkKey object in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/trustFramework/keySets/{id}/uploadCertificate
Content-type: application/json
{
"key": "key-value"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.TrustFramework.KeySets.Item.UploadCertificate;
var requestBody = new UploadCertificatePostRequestBody
{
Key = "key-value",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.TrustFramework.KeySets["{trustFrameworkKeySet-id}"].UploadCertificate.PostAsync(requestBody);
mgc-beta trust-framework key-sets upload-certificate post --trust-framework-key-set-id {trustFrameworkKeySet-id} --body '{\
"key": "key-value"\
}\
'
// 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"
graphtrustframework "github.com/microsoftgraph/msgraph-beta-sdk-go/trustframework"
//other-imports
)
requestBody := graphtrustframework.NewUploadCertificatePostRequestBody()
key := "key-value"
requestBody.SetKey(&key)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
uploadCertificate, err := graphClient.TrustFramework().KeySets().ByTrustFrameworkKeySetId("trustFrameworkKeySet-id").UploadCertificate().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.trustframework.keysets.item.uploadcertificate.UploadCertificatePostRequestBody uploadCertificatePostRequestBody = new com.microsoft.graph.beta.trustframework.keysets.item.uploadcertificate.UploadCertificatePostRequestBody();
uploadCertificatePostRequestBody.setKey("key-value");
var result = graphClient.trustFramework().keySets().byTrustFrameworkKeySetId("{trustFrameworkKeySet-id}").uploadCertificate().post(uploadCertificatePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const trustFrameworkKey = {
key: 'key-value'
};
await client.api('/trustFramework/keySets/{id}/uploadCertificate')
.version('beta')
.post(trustFrameworkKey);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\TrustFramework\KeySets\Item\UploadCertificate\UploadCertificatePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new UploadCertificatePostRequestBody();
$requestBody->setKey('key-value');
$result = $graphServiceClient->trustFramework()->keySets()->byTrustFrameworkKeySetId('trustFrameworkKeySet-id')->uploadCertificate()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
key = "key-value"
}
Invoke-MgBetaUploadTrustFrameworkKeySetCertificate -TrustFrameworkKeySetId $trustFrameworkKeySetId -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.trustframework.keysets.item.upload_certificate.upload_certificate_post_request_body import UploadCertificatePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = UploadCertificatePostRequestBody(
key = "key-value",
)
result = await graph_client.trust_framework.key_sets.by_trust_framework_key_set_id('trustFrameworkKeySet-id').upload_certificate.post(request_body)
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
{
"kid": "kid-value",
"use": "sig",
"kty": "oct",
"nbf": 1508969811,
"exp": 1508973711
}