trustFrameworkKeySet: getActiveKey

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.

Get the currently active trustFrameworkKey in a trustFrameworkKeySet. Only one key is active in the keyset at a time.

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.Read.All TrustFrameworkKeySet.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application TrustFrameworkKeySet.Read.All TrustFrameworkKeySet.ReadWrite.All

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

GET /trustFramework/keySets/{id}/getActiveKey

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

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.

GET https://graph.microsoft.com/beta/trustFramework/keySets/{id}/getActiveKey

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

{
  "k": "k-value",
  "x5c": [
    "x5c-value"
  ],
  "x5t": "x5t-value",
  "kty": "kty-value",
  "use": "use-value",
  "exp": 99
}