trustFrameworkKeySet resource type

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.

Represents a trust framework keyset/policy key. The Identity Experience framework stores the secrets, which can be used in the policies. The secrets can be passwords, certificates, or other files. In the portal, these entities are shown as Policy keys. The Identity Experience framework uses the JSON Web Key (JWK) standard for the keysets. This entity follows the format specified in RFC 7517 Section 5.

Inherits from entity.

Methods

Method Return type Description
List trustFrameworkKeySet collection Get a list of the trustFrameworkKeySet objects and their properties.
Create trustFrameworkKeySet Create a new trustFrameworkKeySet object.
Get trustFrameworkKeySet Read the properties and relationships of a trustFrameworkKeySet object.
Update trustFrameworkKeySet Update the properties of a trustFrameworkKeySet object.
Generate key trustFrameworkKey Generate a key in keyset.
Upload secret trustFrameworkKey Upload a string based secret.
Get active key trustFrameworkKey Get currently active key in the keyset.
Upload X.509 certificate trustFrameworkKey Upload a X.509 certificate.
Upload PKCS12 certificate trustFrameworkKey Upload a PKCS12 format certificate.

Properties

Property Type Description
id String Unique identifier of the trustframework keyset Inherited from entity.
keys trustFrameworkKey collection A collection of the keys.

Relationships

Relationship Type Description
keys_v2 trustFrameworkKey_v2 collection A collection of the keys.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.trustFrameworkKeySet",
  "id": "String (identifier)",
  "keys": [
    {
      "@odata.type": "microsoft.graph.trustFrameworkKey"
    }
  ]
}