trustFrameworkKeySet: uploadSecret

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 plain text secret to a trustFrameworkKeyset. Examples of secrets are application secrets in Azure Active Directory, Google, Facebook, or any other identity provider. his method returns trustFrameworkKey.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) TrustFrameworkKeySet.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application TrustFrameworkKeySet.ReadWrite.All

HTTP request

POST /trustFramework/keySets/{id}/uploadSecret

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-type application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
use String Similar to the use property of trustFrameworkKey.
k String Similar to the k property of trustFrameworkKey. This is the field that is used to send the secret.
nbf Int64 Similar to the nbf property of trustFrameworkKey.
exp Int64 Similar to the exp property of trustFrameworkKey.

Response

If successful, this method returns a 200 OK response code and a new trustFrameworkKey object in the response body.

Examples

Request

The following is an example of the request.

POST https://graph.microsoft.com/beta/trustFramework/keySets/{id}/uploadSecret
Content-type: application/json

{
  "use": "use-value",
  "k": "application-secret-to-be-uploaded",
  "nbf": 1508969811,
  "exp": 1508973711
}

Response

The following is an example of 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": "use-value",
	"kty": "OCT",
	"nbf": 1508969811,
	"exp": 1508973711
}