プロファイル データを取得する

  • [アーティクル]

ユーザーのソフトウェア証明書プロファイルの一覧を取得します。 この一覧には、現在のユーザーが実行できる操作が含まれています。 指定した操作のいずれかに対して、要求を開始できます。

重要

サーバーによって PIN が設定されるのは、プロファイル テンプレート ポリシーで実行する必要があることを示している場合のみです。 それ以外の場合、ユーザーは PIN を指定する必要があります。

注意

この記事の URL は、 などの https://api.contoso.comAPI デプロイ中に選択されたホスト名に対する相対 URL です。

Request

Method 要求 URL
GET /CertificateManagement/api/v1.0/profiles
/CertificateManagement/api/v1.0/profiles/{id}
/CertificateManagement/api/v1.0/requests/{requestid}/profiles

URL パラメーター

パラメーター 説明
id 返すプロファイルの識別子 (GUID)。
requestId プロファイルを返す要求の識別子。

クエリ パラメーター

パラメーター 説明
status 省略可能。 データを取得するプロファイルの状態を示します。 使用可能な状態の種類は、"アクティブ"、"承認済み"、"キャンセル済み"、"完了"、"拒否"、"実行中"、"失敗"、"なし"、"保留中" です。
状態が指定されていない場合は、状態に関係なく、すべてのプロファイルが返されます。

要求ヘッダー

一般的な要求ヘッダーについては、「CM REST API サービスの詳細」の「HTTP 要求ヘッダーと応答ヘッダー」を参照してください。

要求本文

なし。

Response

このセクションでは、応答について説明します。

応答コード

コード 説明
200 OK
204 コンテンツはありません
403 Forbidden
500 内部エラー

応答ヘッダー

一般的な応答ヘッダーについては、「CM REST API サービスの詳細」の「HTTP 要求ヘッダーと応答ヘッダー」を参照してください。

応答本文

成功すると、JSON でシリアル化された Microsoft.Clm.Shared.Profiles.Profile オブジェクトと次のプロパティの一覧が返されます。

プロパティ 説明
AssignedUserUuid プロファイルが割り当てられるユーザーの識別子。
コメント プロファイルを説明するコメント。
Flags プロファイルを説明するフラグ。
ParentProfileUuid プロファイルが置き換えられた古いプロファイルの識別子。
PrimaryProfileUuid プライマリ プロファイルの識別子。
ProfileOperations プロファイルで現在のユーザーが実行できる操作の一覧。
ProfileTemplateUuid プロファイルを管理するポリシーと設定を含むプロファイル テンプレートの識別子。
ProfileTemplateVersion プロファイルが作成されたときのプロファイル テンプレートのバージョン。
Status プロファイルの状態。
Uuid プロファイルの識別子。

例

このセクションでは、ユーザーのプロファイル データを取得する例を示します。

例: 要求

GET /certificatemanagement/api/v1.0/profiles?status=Active HTTP/1.1

例: 応答

HTTP/1.1 200 OK

[
    {
        "Uuid":"c0dd5c7d-ec35-4346-baca-3ad711e9722f",
        "Status":2,
        "Flags":1,
        "ParentProfileUuid":"1c9e2606-fea2-4048-a6ac-b014e54c22df",
        "PrimaryProfileUuid":"00000000-0000-0000-0000-000000000000",
        "AssignedUserUuid":"0378a33b-8650-4713-a727-efd233903643",
        "ProfileTemplateUuid":"8f31803f-8afc-49bb-911d-402ec264b589",
        "ProfileTemplateVersion":8,
        "Comment":"",
        "ProfileOperations":[
            "renew",
            "disable",
            "recover"
        ]
    },
    {
        "Uuid":"5ad77b40-aa42-4533-9396-c9c59fd021a8",
        "Status":2,
        "Flags":1,
        "ParentProfileUuid":"00000000-0000-0000-0000-000000000000",
        "PrimaryProfileUuid":"00000000-0000-0000-0000-000000000000",
        "AssignedUserUuid":"0378a33b-8650-4713-a727-efd233903643",
        "ProfileTemplateUuid":"8f31803f-8afc-49bb-911d-402ec264b589",
        "ProfileTemplateVersion":8,
        "Comment":"",
        "ProfileOperations":[
            "renew",
            "disable",
            "recover"
        ]
    },
    {
        "Uuid":"ff342953-c444-4dc7-b144-f5515d6460c6",
        "Status":2,
        "Flags":1,
        "ParentProfileUuid":"00000000-0000-0000-0000-000000000000",
        "PrimaryProfileUuid":"00000000-0000-0000-0000-000000000000",
        "AssignedUserUuid":"0378a33b-8650-4713-a727-efd233903643",
        "ProfileTemplateUuid":"1e3a31fe-699b-4a6b-945c-18b83c985bc1",
        "ProfileTemplateVersion":9,
        "Comment":"",
        "ProfileOperations":[
            "renew",
            "disable"
        ]
    }
]

関連項目