🆕Management REST API
SCEPman Enterprise Edition only
Applicable to version 3.1 and above
The Management API provides administrative access to issued certificates in SCEPman. It is intended for management and operational workflows such as locating certificates and revoking them when needed.
These endpoints are available under /api/manage and require an authenticated user with the Manage.All role in SCEPman-api.
Authentication
The API uses Entra authentication. The easiest way to authenticate is often the Microsoft Authentication Library (MSAL).
One way to get a bearer token for the Management API is with the Azure CLI. The required value for the `--resource` parameter is the Application ID URI of your SCEPman-api app registration (usually its Application ID prefixed with api://).
az account get-access-token --resource api://[APPLICATION-ID] --query accessToken --output tsvFor example:
TOKEN=$(az account get-access-token \
--resource api://16b6a4d1-0a20-4b41-bf58-12783034cad3 \
--query accessToken \
--output tsv)You can then use that token in the API calls:
curl -X GET "https://scepman.contoso.com/api/manage/search?searchText=ABC123&pageSize=10&certValidity=Any&certType=Any" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"Search API
GET /api/manage/search
Searches issued certificates and returns a paginated result set.
Search parameters
searchText
Free-text search term used to find matching certificates. This is typically used for substring-based lookups, for example matching requester or other searchable certificate metadata.
pageSize
Maximum number of certificates returned in a single response page.
Default: 50
continuationToken
Optional pagination token used to request the next page of results.
Pass back the continuationToken returned by a previous search response to continue fetching more certificates.
certValidity
Filters certificates by validity state.
Default:
Any
Valid values are Any, Active, Expired, Revoked.
certType
Filters certificates by certificate type.
Default:
Any
This can be used to restrict the result set to specific certificate categories. Valid values are Static, DC, User, Device, and Any.
Sources
Filters certificates by the endpoint through which they have been issued. You can specify this filter multiple times, once per source.
Default: No restriction
Valid values are shown in the table below, you must specify the source using their integer values:
CertificateMaster
0
Intune
1 or 9 (use both to ensure finding all)
Static
3
StaticAAD
4
Jamf
5
DomainController
6
API
7
RadiusAPI
8
Active Directory
10
The response is a paginated list of certificate records plus a continuation token for fetching the next page.
Example
Example response
Revocation API
PATCH /api/manage/revoke/{serialNumber}
Revokes a certificate identified by its serial number.
The request body contains:
revocationReason- an integer for the reason of revocation. See the table below for possible valuesrevoker(optional) - a free-text identifier for the person or system requesting revocation
Example
Successful response
Certificate not found
Already revoked
Supported revocation reasons
The API supports the revocation reasons specified in RFC 5280:
0
Unspecified
1
KeyCompromise
2
CACompromise
3
AffiliationChanged
4
Superseded
5
CessationOfOperation
6
CertificateHold
8
RemoveFromCrl
9
PrivilegeWithdrawn
10
AACompromise
Last updated
Was this helpful?