名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリケーションまたはサービス プリンシパルに関連付けられているキー資格情報が含まれます。 アプリケーションおよび servicePrincipal エンティティの keyCredentials プロパティと、onPremisesPublishing の verifiedCustomDomainKeyCredential プロパティで構成され、カスタム ドメインのキー資格情報を表します。
Microsoft Graph を使用して keyCredential を追加するには、「 Microsoft Graph を使用してアプリに証明書を追加する」を参照してください。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| customKeyIdentifier | Binary | 資格情報の識別に使用できる 40 文字のバイナリ型。 省略可能。 ペイロードに指定されていない場合、既定値は証明書のサムプリントになります。 |
| displayName | 文字列 | キーのフレンドリ名 (最大長は 90 文字)。 長い値は受け入れられますが、短縮されます。 省略可能。 |
| endDateTime | DateTimeOffset | 資格情報の有効期限が切れる日時。 DateTimeOffset 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| key | Binary | キー資格情報の値。 Base64 でエンコードされた値である必要があります。 取得するには $select が必要です。GET /servicePrincipals/{servicePrincipalId}?$select=keyCredentialsGET /applications/{applicationId}?$select=keyCredentialsそれ以外の場合は常にnullです。 .cer証明書から、Convert.ToBase64String() メソッドを使用してキーを読み取ることができます。 詳細については、「 証明書キーを取得する」を参照してください。 |
| keyId | Guid | キーの一意の識別子。 |
| startDateTime | DateTimeOffset | 資格情報が有効になる日時。タイムスタンプの種類は、ISO 8601 形式を使用して日時情報を表し、常に UTC 時刻になります。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| type | String | キー資格情報の種類。たとえば、 Symmetric、 AsymmetricX509Cert、 X509CertAndPassword などです。 |
| usage | 文字列 | キーを使用できる目的を説明する文字列。たとえば、 None、 Verify、 PairwiseIdentifier、 Delegation、 Decrypt、 Encrypt、 HashedIdentifier、 SelfSignedTls、 Sign などです。 usage が Signの場合は、種類を X509CertAndPassword にし、署名用の passwordCredentials を定義する必要があります。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.keyCredential",
"customKeyIdentifier": "Binary",
"displayName": "String",
"endDateTime": "String (timestamp)",
"key": "Binary",
"keyId": "Guid",
"startDateTime": "String (timestamp)",
"type": "String",
"usage": "String"
}