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