Cloud Administration Generate Enrollment Code API

Use the Cloud Administration Generate Enrollment Code API to generate the verification code for admin-assisted secure enrollment for a list of users.

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 generate a verification code for a user.

Example Request Data

The following example displays a request.

POST /AdminInterface/restapi/v1/users/generateVerifyCode/enroll

Accept: application/json

Authorization: Bearer <JWT token>

Request Body Parameters

The following table describes the request body parameters.

Example Request Body

The following example request body

[{
        "email": "local_rsa_unified@example.com"
    }, {
        "email": "administrator@example.com",
        "custom_email": "administrator.admin@example.com",
        "code_send_to": "EMAIL"
    }, {
        "email": "ADUser@example.com",
        "code_send_to": "DISPLAY"
    }, {
        "email": "alice@example.com",
        "code_send_to": "DISPLAY"
    }, {
        "email": "amuser@example.com",
        "code_send_to": "DISPLAY"
    }, {
        "email": "AMViaPref0@example.com",
        "code_send_to": "DISPLAY"
    }
]

Example Response Body

The following example response shows verification code for all users when generated successfully.

[{
        "status": 1006,
        "errorMessage": "Code generation is not allowed, please check the configuration settings.",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "local_rsa_unified@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "DISPLAY"
        }
    }, {
        "status": 1005,
        "errorMessage": "Unable to send Email, please check \"Company Settings\".",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "administrator@example.com",
            "custom_email": "administrator.admin@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "EMAIL"
        }
    }, {
        "status": 1000,
        "errorMessage": "Code Successfully generated. ",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "ADUser@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "DISPLAY"
        },
        "verify_code": "629211156",
        "verify_code_validity_time": "2023-07-25 05:55:23 UTC",
        "verify_code_generation_mode": "ENROLLMENT",
        "verification_Link": "https://thr-qd4-ngx-00.auth-dev.securid.com/enroll/admin"
    }, {
        "status": 1000,
        "errorMessage": "Code Successfully generated. ",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "alice@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "DISPLAY"
        },
        "verify_code": "628078239",
        "verify_code_validity_time": "2023-07-25 05:55:23 UTC",
        "verify_code_generation_mode": "ENROLLMENT",
        "verification_Link": "https://thr-qd4-ngx-00.auth-dev.securid.com/enroll/admin"
    }, {
        "status": 1000,
        "errorMessage": "Code Successfully generated. ",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "amuser@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "DISPLAY"
        },
        "verify_code": "977790778",
        "verify_code_validity_time": "2023-07-25 05:55:23 UTC",
        "verify_code_generation_mode": "ENROLLMENT",
        "verification_Link": "https://thr-qd4-ngx-00.auth-dev.securid.com/enroll/admin"
    }, {
        "status": 1000,
        "errorMessage": "Code Successfully generated. ",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "AMViaPref0@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "DISPLAY"
        },
        "verify_code": "318206185",
        "verify_code_validity_time": "2023-07-25 05:55:23 UTC",
        "verify_code_generation_mode": "ENROLLMENT",
        "verification_Link": "https://thr-qd4-ngx-00.auth-dev.securid.com/enroll/admin"
    }
]

Note:  If the request contains any duplicate user information, the duplicates will be filtered and the code will be generated only once in the response.

Example Request Body with Duplicate Entries

[{
        "email": "administrator@example.com",
        "custom_email": "administrator.admin@example.com",
        "code_send_to": "EMAIL"
    }, {
        "email": "administrator@example.com",
        "custom_email": "administrator.admin@example.com",
        "code_send_to": "EMAIL"
    }, {
        "email": "dummyUser@example.com",
        "custom_email": "noemail@example.com",
        "code_send_to": "EMAIL"
    },
]

Example Response Body After Filtering Duplicate Entries

[{
        "status": 1000,
        "errorMessage": "Code Successfully generated. ",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "administrator@example.com",
            "custom_email": "administrator.admin@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "EMAIL"
        }
    }, {
        "status": 1000,
        "errorMessage": "Code Successfully generated. ",
        "userDetailsRequestForVerifyCodeGeneration": {
            "email": "dummyUser@example.com",
            "custom_email": "noemail@example.com",
            "code_validity": "10",
            "validity_time_duration_unit": "MIN",
            "code_send_to": "EMAIL"
        }
    }
]

Response Property Descriptions

The following table shows response property descriptions and the associated data types.

Response Codes

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