Certificate Management

Export certificate details to a CSV file

Export Certificate Details to CSV: Certificate details export involves several API calls:

Initiate the processing of certificate details to be exported:
GET api/v2/certificates/search_export

Get status of the export process:
GET api/v2/certificates/search_export_status

Download the CSV file:
GET api/v2/certificates/search_download_csv

Initiate the processing of certificate details to be exported

Initiates processing certificate details to query.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, View certificates

HTTP method

POST

Request URI

api/v2/certificates/search_export

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

ceSettingName

Required

Parameter Type: Request body

Data Type: String

Certificate enrollment configuration name.

LccalCE

certificateStatus

Required

Parameter Type: Request body

Data Type: String

Status of the target certificate.

Can be one of:

ACTIVE

EXPIRED

PENDING_REVOCATION

MANUAL_REVOCATION_REQUIRED

REVOKED

SENT

WAITING_SEND

GENERATING

HIGH_GENERATING

ACTIVE

userId

Parameter Type: Request body

Data Type: String

User ID associated with the target certificates.

 

deviceUUID

Parameter Type: Request body

Data Type: String

Device uuid associated with the target certificates.

5f1db255-8d3d-4943-8bab-d556cacce855

expiresAfter

Parameter Type: Request body

Data Type: Date

Gets certificates that are going to expire after this date.

The values are expressed milliseconds since Unix epoch time.

Example:

1785823788000 is epoch time for Tue, 04

expiresBefore

Parameter Type: Request body

Data Type: Date

Gets certificates that are going to expire before this date.

The values are expressed milliseconds since Unix epoch time.

Example:

1785823788000 is epoch time for Tue, 04

Response fields

Field

Description

exportStatusPollUrl

URL to get status of the search export.

csvDownloadUrl

URL to download the CSV file.

messages

Container for messages.

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

    messageParameters

 

Sample Request

curl -k -sS -u <userName>:<password> -XPOST -H "Content-Type: application/json"  -d '{"ceSettingName":"LocalCE","certificateStatus":"ACTIVE"}' 'https://<core>/api/v2/certificates/search_export?adminDeviceSpaceId=1'

Sample Responses

Success:

{

    "results": {

        "exportStatusPollUrl": "/api/v2/certificates/search_export_status",

        "csvDownloadUrl": "/api/v2/certificates/search_download_csv"

    },

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.rest.controllers.CertificateManagementController.Messages.PROCESS_INITIATED",

            "localizedMessage": "Certificate details export process initiated successfully",

            "messageParameters": [ ]

        }

    ]

}

If the process is already initiated:

{

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.rest.controllers.CertificateManagementController.Messages.PROCESS_INITIATED",

            "localizedMessage": "Certificate details export is already progress. It might be issued by a different user",

            "messageParameters": [ ]

        }

    ]

}

Get status of the export process

This call gets the status of the certificate details export process.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, view certificates

Category: Device Management

Role Description: View dashboard, device page, device details

HTTP method

GET

Request URI

api/v2/certificates/search_export_status

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

Response fields

Field

Description

Results

Container for results.

 

Boolean value that indicates whether the audit logs processing is progressing or not.

 

Audit Logs processing status/progress message.

"success" - If the processing is completed successfully.

"fail" - If the processing failed due to server error.

 

Path to the CSV file.

isExportStatusAvailable

Is the export progress status available.

Sample Request

curl -sS -k -u <userName>:<password> -G https://<core>/api/v2/certificates/
search_export_status?adminDeviceSpaceId=1

Sample Response

{

"results":{"isRunning":false,

"exportStatusMsg":"success",

"csvFileName":"/mi/tomcat/temp/certificates-5007291726810485269.csv",

"isExportStatusAvailable":true,"initiatedAt":1461110928255}

}

Download the CSV file

This call downloads the CSV file.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, View certificates

Category: Device Management

Role Description: View dashboard, device page, device details

HTTP method

GET

Request URI

api/v2/certificates/search_download_csv

Request parameters

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Query

Data Type: Number

Device space ID of the administrator.

1

Sample Request

curl -o output.csv -k -sS -u <userName>:<password> -XGET -H "Content-Type: text/csv" 'https://<core>/api/v2/certificates/search_download_csv?adminDeviceSpaceId=1'

Search/Retrieve certificate details

This call returns a list of certificate details.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, View certificates

Category: Device Management

Role Description: View dashboard, device page, device details

HTTP method

GET

Request URI

api/v2/certificates/search

Request parameters

 

Parameter

Description

Sample Value

adminDeviceSpaceId

Required

Parameter Type: Request body

Data Type: Number

Device space ID of the administrator.

1

ceSettingName

Required

Parameter Type: Request body

Data Type: String

This is the certificate enrollment configuration name.

LocalICE

certificateStatus

Parameter Type: Request body

Data Type: String

Status of the target certificate.

Can be one of:

ACTIVE

EXPIRED

PENDING_REVOCATION

MANUAL_REVOCATION_REQUIRED

REVOKED

SENT

WAITING_SEND

GENERATING

HIGH_GENERATING

ACTIVE

userId

Parameter Type: Request body

Data Type: String

User ID associated with the target certificates.

 

deviceUUID

Parameter Type: Request body

Data Type: String

Device uuid associated with the target certificates.

5f1db255-8d3d-4943-8bab-d556cacce855

expiresAfter

Parameter Type: Request body

Data Type: Date

Gets certificates that are going to expire after this date.

The values are expressed milliseconds since Unix epoch time.

Example:

1785823788000 is epoch time for Tue, 04

expiresBefore

Parameter Type: Request body

Data Type: Date

Gets certificates that are going to expire before this date.

The values are expressed milliseconds since Unix epoch time.

Example:

1785823788000 is epoch time for Tue, 04

Response fields

Field

Description

results

An array of certificate objects.

    id

 

    serialNumber

 

    type

 

    trash

 

    expiredAt

 

    createdAt

 

    userId

 

    deviceId

 

    deviceUuid

 

    localCAId

 

    ceSettingName

 

    certificateStatus

 

    ceId

 

    consumerAppSettings

 

messages

Container for messages.

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

    messageParameters

 

resultCount

The number of entries that are being returned.

Sample request and response

Request

curl -k -sS -u userName>:<password> -XPOST -H "Content-Type: application/json"  -d '{"adminDeviceSpaceId":1",ceSettingName":"LocalCE","certificateStatus":"ACTIVE"}' 'https://<core>/api/v2/certificates/search'

Response

{

    "results": [

        {

            "id": 2,

            "serialNumber": 102,

            "type": "Centralized",

            "trash": true,

            "expiredAt": "2017-04-18",

            "createdAt": "2016-04-18",

            "userId": 9002,

            "deviceId": 1,

            "deviceUUid": null,

            "localCAId": 3,

            "ceSettingName": "LocalCE",

            "certificateStatus": "ACTIVE",

            "ceId": 8,

            "consumerAppSettings": [

                8

            ]

        },

...

    ],

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.rest.controllers.CertificateManagementController.Messages.SUCCESS",

            "localizedMessage": "Certificates successfully retrieved",

            "messageParameters": [ ]

        }

    ],

    "resultCount": 6

}

Managing user certificates

You use the following calls to:

Upload user-provided certificates

Delete user-provided certificates

Get list of user provided certificate enrollment ID information with associated certificate details

Get list of all user provided certificate enrollment IDs' information with associated certificate details.

Error checking and validation

Core will display an error message warning when a configuration is created without a private key password for configurations used by iOS_MDM_OTA, Android for Work and Windows. These configurations require a private key password and will not work without one.

Core verifies the file type of user-provided certificates, generates an error message popup and does not save the file if it is not a valid PKCS#12.

Core verifies if the supplied Certificate Enrollment ID (CEid) is a valid user provided configuration and generates an error message if it is not.

Core verifies if the supplied userId is a valid user principal and generates an error message if it is not.

Core will display an error message with response code 410 if the V1 API for managing user-provided certificates is used.

Upload user-provided certificate

Use this call to upload a user-provided certificate.

Note: Only upload version 3 and above certificates. If you upload version 2 or below certificates, then you may encounter issues when using Core. User-provided certificates can only contain one private key. Uploaded PKCS#12 files containing more than one private key are not supported and will not work. You must repackage these certificates so the PKCS#12 file contains only one private key used to generate the certificate for the intended use.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

POST

Request URI

/api/v2/configuration/CE/USER_PROVIDED/{CEid}/uploadCertificate

Request parameters

Parameter

Description

Sample Value

CEid

Required

Parameter Type: Query path

Data Type: String

Internal certificate ID

To find the value for CEid, use the call, Get CE configuration information.

10

file

Required

Parameter Type: Request payload

Data Type: Multi-part file

The location of the certificate p12 file

@//Users/patluri/Downloads/MIQAMDMProduction.p12

principal

Required

Parameter Type: Request payload

Data Type: String

Username of the certificate owner

See the note below about usernames containing special characters.

-F principal='theadmin'

password

Required

Parameter Type: Request payload

Data Type: String

Form-encoded string

-F password='xyzsdmobile'

Response fields

Field

Description

messages

Container for messages.

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

Sample Request

curl -sS -v -k -u miadmin:Mi4man11 'https://<core>/api/v2/configuration/CE/USER_PROVIDED/10/uploadCertificate' -X POST -F file=@//Users/patluri/Downloads/MIQAMDMProduction.p12 -F password='xyzsdmobile' -F principal='theadmin'

Sample Response

{
    "messages": [
        {
            "type": "Info",
            "messageKey": "com.mobileiron.vsp.rest.controllers.UserProvidedCertificatesControllerV2.Messages.SUCCESS_UPLOAD",
            "localizedMessage": "Certificate successfully uploaded."
        }
    ]
}

Delete user-provided certificates

Use this call to delete a user-provided certificate.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

POST

Request URI

api/v2/configuration/CE/USER_PROVIDED/{CEid}/deleteCertificate

Request parameters

Parameter

Description

Sample Value

CEid

Required

Parameter Type: Query path

Data Type: String

Internal certificate ID.

10

userId

Required

Parameter Type: Request payload

Data Type: String

Username of the certificate owner.

d '{"userId": "theadmin"}

Response fields

Field

Description

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

Sample Request

curl -k -sS -u <username>:<password> -XPOST -H "Content-Type: application/json" 'https://<core>/api/v2/configuration/CE/USER_PROVIDED/10/deleteCertificate' -d '{"userId": "theadmin"}'

Sample Response

{
    "messages": [
        {
            "type": "Info",
            "messageKey": "com.mobileiron.vsp.rest.controllers.UserProvidedCertificatesControllerV2.Messages.SUCCESS_DELETE_PRIVATE_KEY",
            "localizedMessage": "Successfully deleted private key from certificate."
        }
    ]
}

Get list of user provided certificate enrollment ID information with associated certificate details

This call gets a list of user provided certificate enrollment ID information with associated certificate details.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

POST

Request URI

api/v2/configuration/CE/USER_PROVIDED/{CEid}/getCertificate

Request parameters

Parameter

Description

Sample Value

CEid

Required

Parameter Type: Query path

Data Type: String

Internal certificate ID.

10

usernId

Required

Parameter Type: Request payload

Data Type: String

Username of the certificate owner.

-d '{"userId": "theadmin"}'

Response fields

Field

Description

results

Container for results. Results are an array of the fields shown in the sample response below.

messages

Container for messages.

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

Sample Request

curl -k -sS -u <username>:<password> -XPOST -H "Content-Type: application/json" 'https://<core>/api/v2/configuration/CE/USER_PROVIDED/10/getCertificate' -d '{"userId": "theadmin"}'

Sample Response

{

    "results": {

        "id": null,

        "version": "3",

        "serialNumber": "xxx4493327816883622",

        "signatureAlgorithm": "SHA256WITHRSA",

        "issuer": "C=US, O=Apple Inc., OU=Apple Certification Authority, CN=Apple Application Integration 2 Certification Authority",

        "notBefore": 1573162384000,

        "notAfter": 1604698384000,

        "subject": "C=US, CN=APSP:9c3811ce-0ff0-4272-be0b-2df8f1f85bb5, UID=com.apple.mgmt.External.9c3811ce-0ff0-4272-be0b-2df8f1f85bb5",

        "subjectAltNames": null,

        "cert": null,

        "certType": null,

        "alias": null,

        "certData": null,

        "createdAt": null,

        "modifiedAt": null,

        "commonName": "APSP:xxx811ce-0ff0-4272-be0b-2df8f1f85bb5",

        "iPhoneUID": null,

        "iPhoneDevelopmentAPNSCert": false,

        "identity": false,

        "validTimeLine": false

    },

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.rest.controllers.UserProvidedCertificatesControllerV2.Messages.SUCCESS_GET_CERTIFICATE",

            "localizedMessage": "Certificate successfully retrieved."

        }

    ]

}

Get list of all user provided certificate enrollment IDs' information with associated certificate details.

This call gets a list of all user provided certificate enrollment IDs information with associated certificate details.

Required Roles

You need to have access to the User Portal for this call.

 

 

HTTP method

POST

Request URI

api/v2/configuration/CE/USER_PROVIDED/all/getAllUserProvidedCertificateDetails

Request parameters

Parameter

Description

Sample Value

userId

Required

Parameter Type: Request payload

Data Type: String

Username of the certificate owner.

-d '{"userId": "theadmin"}'

Response fields

Field

Description

results

Container for results. Results are an array of the fields shown in the sample response below.

messages

Container for messages.

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

Sample Request

curl -k -sS -u <username>:<password> -XPOST -H "Content-Type: application/json" 'https://<core>/api/v2/configuration/CE/USER_PROVIDED/all/getAllUserProvidedCertificateDetails' -d '{"userId": "theadmin"}'

Sample Response

{

  "results": [

    {

      "ceId": 10,

      "certificateId": 11,

      "requirePassword": true,

      "displayName": "testUserProv",

      "certificateExpirationDate": 1604698384000,

      "certificateUploadedDate": 1577964355000,

      "isPkcs12": true

    }

  ],

  "messages": [

    {

      "type": "Info",

      "messageKey": "com.mobileiron.vsp.rest.controllers.UserProvidedCertificatesControllerV2.Messages.SUCCESS_GET_CE_DETAILS",

      "localizedMessage": "User provided certificate enrollment details successfully retrieved."

    }

  ]

}

Revoke certificates belonging to external certificate enrollment

Revoking certificates involves the following calls:

Determine if certificate revocation is in progress
GET api/v2/certificateCheckJob/attemptRevokeForPendingRevocation/status

Revoke certificates
POST api/v2/certificateCheckJob/attemptRevokeForPendingRevocation

Determine if certificate revocation is in progress

This call returns information about whether certificate revocation is already in progress.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, View certificates

HTTP method

GET

Request URI

api/v2/certificateCheckJob/attemptRevokeForPendingRevocation/status

Sample request

curl -k -sS -u <username>:<password> -XGET 'https://core/api/v2/certificateCheckJob/attemptRevokeForPendingRevocation/status

Sample responses

Pending revocation certs are not being processed.

 

Pending revocation certs are being processed. Total duration so far 76 Seconds

Revoke certificates

This calls attempts to revoke certificates belonging to external certificate enrollment.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, View certificates

HTTP method

POST

Request URI

api/v2/certificateCheckJob/attemptRevokeForPendingRevocation

Response fields

Field

Description

messages

Container for response.

    type

Message type.

    messageKey

Message key.

    localizedMessage

Localized message with parameters resolved.

Sample Request

curl -k -sS -u <username>:<password> -XPOST 'https://core/api/v2/certificateCheckJob/attemptRevokeForPendingRevocation'

Sample Response

{

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.messages.http.200",

            "localizedMessage": "Success"

        }

    ]

}

Get SCEP configuration information

This call gets SCEP configuration information for the provided sub-type.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

GET

Request URI

api/v2/configuration/SCEP/{appsubtype}/summary

Request parameters

Parameter

Description

Sample Value

appsubtype

Required

Parameter Type: Path

Data Type: String

The sub-type about which to fetch information.

Can be:

BLUE_COAT

CLIENT_PROVIDED

USER_PROVIDED

ENTRUST

GLOBAL_SIGN,LOCAL

OPEN_TRUST

SCEP,SINGLE_FILE_IDENTITY

SYMANTEC_MANAGED_PKI

SYMANTEC_WS_MANAGED_PKI

USER_PROVIDED

Response fields

Field

Description

results

 

    name

 

    value

 

    appType

 

    appSubType

 

    rowType

 

resultCount

 

Sample request

curl -k -sS -u <username>:<password> -XGET 'https://<core>/api/v2/configuration/SCEP/USER_PROVIDED/summary'

Sample response

{"results":

    [{

        "name":"user-provided",

        "value":"10",

        "appType":"SCEP",

        "appSubType":"USER_PROVIDED",

        "rowType":"ADMIN"

    }],

"resultCount":1

}

Get CE configuration information

This call gets Certificate Enrollment (CE) configuration information for the provided sub-type.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Roles

Category: Logs and Events Management

Role Description: Manage certificates, View certificates

HTTP method

GET

Request URI

api/v2/configurations/CE/{caprotocol}/configurations

Request parameters

Parameter

Description

Sample Value

caprotocol

Required

Parameter Type: Path

Data Type: String

The sub-type about which to fetch information.

Can be:

BLUE_COAT,

CLIENT_PROVIDED,

USER_PROVIDED,

ENTRUST,

GLOBAL_SIGN,LOCAL,

OPEN_TRUST,

SCEP,SINGLE_FILE_IDENTITY,

SYMANTEC_MANAGED_PKI,

SYMANTEC_WS_MANAGED_PKI

USER_PROVIDED

Response fields

Field

Description

results

 

    name

 

    value

 

    appType

 

    appSubType

 

    rowType

 

resultCount

 

Sample request

curl -k -sS -u <username>:<password> -XGET 'https://<core>/api/v2/configurations/CE/USER_PROVIDED'

Sample response

{"results":

    [{

        "name":"user-provided",

        "value":"10",

        "appType":"SCEP",

        "appSubType":"USER_PROVIDED",

        "rowType":"ADMIN"

    }],

"resultCount":1

}

Search for users without certificates

This call searches for users without certificates.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

POST

Request URI

api/v2/configurations/CE/{CEID}/users/withnocerts/search

Request parameters

Parameter

Description

Sample Value

CEID

Required

Parameter Type: Path

Data Type: Number

The id of the certificate enrollment configuration

32

Response fields

Field

Description

results

 

    id

 

    principal

 

    displayName

 

    firstName

 

    lastName

 

    emailAddress

 

messages

 

    type

 

    messageKey

 

    localizedMessage

 

resultCount

 

Sample request

curl -k -sS -u <username>:<password> -XPOST 'https://<core>/api/v2/configurations/CE/32/users/withnocerts/search'

Sample response

{

"results":[

            {

                "id":9001,

                "principal":"miadmin",

                "displayName":"miadmin",

                "firstName":null,

                "lastName":null,

                "emailAddress":"[email protected]"

            }

        ],

"messages":[      

            {

                "type":"Info",

                "messageKey":"com.mobileiron.vsp.rest.controllers.UserAndDeviceSummaryController.Messages.SUCCESS_GET_USERS_DETAILS",

                "localizedMessage":"User details successfully retrieved."

            }

        ],

"resultCount":1

}

Export summary for users without certificates

This call exports the summary for users without certificates.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

POST

Request URI

api/v2/configurations/CE/{CEID}/users/withnocerts/search_export

Request parameters

Parameter

Description

Sample Value

CEID

Required

Parameter Type: Path

Data Type: Number

The id of the certificate enrollment configuration

10

Response fields

Field

Description

results

 

    exportStatusPollUrl

 

    csvDownloadUrl

 

messages

 

    type

 

    messageKey

 

    localizedMessage

 

Sample request

curl -k -sS -u <username>:<password> -XPOST 'https://<core>/api/v2/configurations/CE/10/users/withnocerts/search_export'

Sample response

{

    "results": {

        "exportStatusPollUrl": "/api/v2/configurations/CE/9/users/withnocerts/search_export_status",

        "csvDownloadUrl": "/api/v2/configurations/CE/9/users/withnocerts/search_download_csv"

    },

    "messages": [

        {

            "type": "Info",

            "messageKey": "com.mobileiron.vsp.rest.controllers.UserAndDeviceSummaryController.Messages.PROCESS_INITIATED",

            "localizedMessage": "User details export process initiated successfully."

        }

    ]

}

Export status summary for users without certificates

This call exports the status summary for users without certificates.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

POST

Request URI

api/v2/configurations/CE/{CEID}/users/withnocerts/search_export_status

Request parameters

Parameter

Description

Sample Value

CEID

Required

Parameter Type: Path

Data Type: Number

The id of the certificate enrollment configuration

10

Response fields

Field

Description

results

 

    isRunning

 

    exportStatusMsg

 

    csvFileName

 

    isExportStatusAvailable

 

    initiatedAt

 

Sample request

curl -k -sS -u <username>:<password> -XPOST 'https://<core>/api/v2/configurations/CE/10/users/withnocerts/search_export_status'

Sample response

{

    "results": {

        "isRunning": false,

        "exportStatusMsg": "success",

        "csvFileName": "/mi/tomcat/temp/userdetails-3531617505787171123.csv",

        "isExportStatusAvailable": true,

        "initiatedAt": 1503354251055

    }

}

Download summary for users without certificates

This call downloads the user summary for users without certificates.

Required Roles

See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.

 

Required Role

Category: User Management

Role Description: Manage user

HTTP method

GET

Request URI

api/v2/configurations/CE/{CEID}/users/withnocerts/search_download_csv

Request parameters

Parameter

Description

Sample Value

CEID

Required

Parameter Type: Path

Data Type: Number

The id of the certificate enrollment configuration

10

Sample request

curl -o output.csv -k -sS -u <username>:<password> -XGET -H "Content-Type: text/csv" 'https://<core>/api/v2/configurations/CE/10/users/withnocerts/search_download_csv'