Cloud Administration Void Enrollment Code API

Use the Cloud Administration Void Enrollment Code API to void enrollment codes for a list of users. This API returns a list of users for whom the voiding process succeeded or failed.

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration APIs.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to void a verification code for a user.

Example Request Data

The following example displays a request.

POST /AdminInterface/restapi/v1/users/voidVerifyCode

Accept: application/json

Authorization: Bearer <JWT token>

Request Body Parameters

The following table describes the request body parameters.

Example Request Body

The following is an example request body:

{
    "code_generation_mode": "ENROLLMENT",
    "user_emails": [
        "user1@example.com",
        "user2@example.com",
        "user3@example,com"
    ]
}

Response Body Parameters

The following table describes the request body parameters:

Example Response Body

The following example response shows the results when voiding verification codes for a list of users:

{
    "results": [{
            "status": 1013,
            "errorMessage": "No enrollment code found to void. Enrollment code may have expired or has been used already.",
            "user_email": "user1@example.com"
        }, {
            "status": 1014,
            "user_email": "user2@example.com"
        }, {
            "status": 1002,
            "errorMessage": "Invalid User",
            "user_email": "user3@example.com"
        }
    ]
}

Response Codes

The following table shows response codes and descriptions for this API.