Get profile data

Article
09/14/2023

Gets a list of software certificate profiles for a user. The list includes the possible operations that can be performed by the current user. A request can then be initiated for any of the specified operations.

Important

The server sets the PIN only if the profile template policy indicates that it should be done. Otherwise, the user should supply the PIN.

Note

The URLs in this article are relative to the hostname that's chosen during API deployment, such as https://api.contoso.com.

Request

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

URL parameters

Parameter	Description
id	The identifier (GUID) of the profile to return.
requestId	The identifier of the request to return the profiles for.

Query parameters

Parameter	Description
status	Optional. Indicates the status of the profiles for which to retrieve data. The possible status types are "Active," "Approved," "Canceled," "Completed," "Denied," "Executing," "Failed," "None," and "Pending." If no status is specified, all profiles, regardless of status are returned.

Request headers

For common request headers, see HTTP request and response headers in CM REST API service details.

Request body

None.

Response

This section describes the response.

Response codes

Code	Description
200	OK
204	No content
403	Forbidden
500	Internal Error

Response headers

For common response headers, see HTTP request and response headers in CM REST API service details.

Response body

On success, returns a list of JSON-serialized Microsoft.Clm.Shared.Profiles.Profile objects with the following properties:

Property	Description
AssignedUserUuid	The identifier of the user to whom the profile is assigned.
Comment	The comment that describes the profile.
Flags	The flags that describe the profile.
ParentProfileUuid	The identifier of the old profile that the profile has replaced.
PrimaryProfileUuid	The identifier of the primary profile.
ProfileOperations	The list of possible operations that can be performed by the current user on the profile.
ProfileTemplateUuid	The identifier of the profile template that contains the policies and settings that govern the profile.
ProfileTemplateVersion	The version of the profile template at the time that the profile was created.
Status	The status of the profile.
Uuid	The profile's identifier.

Example

This section provides an example to get the profile data for a user.

Example: Request

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

Example: Response

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"
        ]
    }
]

Share via