Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results forÂ
Search instead forÂ
Did you mean:Â
Announcements
SecurID®
This is the primary landing page for SecurID, where customers and partners can find product documentation, downloads, advisories, forums and other helpful resources for the product.
Hi There,
We are new to the RSA SecurID solutions and still having some minor teething issues.
Can anyone advise why the test authentication RSA Agent 1.42 works for a user on a Macbook but he doesn't get prompted to use MFA when logging into the Macbook. There are a few profiles on the Macbook and we know the Cloud Authentication Service is set up otherwise the tests wouldn't work.
Kind regards
BSIT.
... View more
Hello everyone. I have a question. The sdconf.rec file that I downloaded from my RSA Security Console has old IP address information for the Primary Server (RSA Authentication Manager). However, when I click on the "Radius" tab in the RSA Security Console I can see the correct IP address for my Primary server. Additionally, no matter how many times I click "Generate Configuration File" and download a new AM_Config.zip file, I still see the old IP address for the primary server when uploading the sdconf.rec file during the RSA Authentication Agent installation on my MS Windows Server 2019 virtual machine. Does anyone have an idea why this discrepancy would exist? Also, is there a way to force the "Generate Configuration File" to see the current information? NOTE: I have rebooted my Linux-based RSA Authentication Manager multiple times.
... View more
How do I configure RSA to report what is actually the problem? When a user is disabled in Active Directory, RSA will return a message of "Authentication Fail" vs "Account Disabled" when trying to Authenticate. A message of Authentication Fail causes the user to continue to try their Passcode when that is not the issue. Thanks, Debra
... View more
I received my Seed Media replacement due to Zscaler blocking the download therefore I had to request a replacement. I received the media yesterday, entered the Token Pack ID and Confirmation number and it came back with "You have entered an invalid Token Pack ID and Confirmation Number combination" I have sent this information to the group that provided the replacement CD, was wondering if anyone else has run into this situation and what was the resolution?
... View more
Cloud Administration Generate Verify Code APICloud Administration Generate Verify Code API
Use the Cloud Administration Generate Verify Code API to generate the verification code for admin-assisted secure enrollment for a list of users.
AuthenticationAuthentication
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.
Administrative RolesAdministrative Roles
This API must use an API key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to generate a verification code for a user.
Action
Method
Request URL
Response Content Type
Response Body
Response Codes
Code Generation for Secure Enrollment
POST
AdminInterface/restapi/v1/users/generateVerifyCode/enroll
application/json
json
1000, 1001, 1002, 1003, 1004, 1005, 1006
Example Request BodyExample Request Body
The following example displays a request.
POST /AdminInterface/restapi/v1/users/generateVerifyCode/enroll
Accept: application/json
Authorization: Bearer <JWT token>
Request Body Parameters
Request Body Parameters
The following table describes the request body parameters.
Request Parameter
Description
Required?
Default Value
Data Type
email
User's email address.
Yes
String
custom_email
Email address to which the code will be sent.
OPTIONAL
null
String
code_validity
Validity of the code generated.
Minimum validity is 10 minutes and maximum validity is 24 hours.
OPTIONAL
"10"
String
validity_time_duration_unit
Time duration unit must be MIN or HOUR.
OPTIONAL
"MIN"
String
code_send_to
Mode to determine how the code will be sent.
If the value is DISPLAY, the reset code will be sent in the response.
If the value is EMAIL, the reset code will be sent through email only.
OPTIONAL
"DISPLAY"
String
Example Request BodyExample Request Body
The following example request body [{
"email": "local_rsa_unified@local.com"
}, {
"email": "administrator@support.com",
"custom_email": "administrator.admin@rsa.com",
"code_send_to": "EMAIL"
}, {
"email": "ADUser@support.com",
"code_send_to": "DISPLAY"
}, {
"email": "alice@support.com",
"code_send_to": "DISPLAY"
}, {
"email": "amuser@support.com",
"code_send_to": "DISPLAY"
}, {
"email": "AMViaPref0@support.com",
"code_send_to": "DISPLAY"
}
]
Example Response BodyExample 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@local.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@support.com",
"custom_email": "administrator.admin@rsa.com",
"code_validity": "10",
"validity_time_duration_unit": "MIN",
"code_send_to": "EMAIL"
}
}, {
"status": 1000,
"errorMessage": "Code Successfully generated. ",
"userDetailsRequestForVerifyCodeGeneration": {
"email": "ADUser@support.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@support.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@support.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@support.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 EntriesExample Request Body with Duplicate Entries [{
"email": "administrator@support.com",
"custom_email": "administrator.admin@rsa.com",
"code_send_to": "EMAIL"
}, {
"email": "administrator@support.com",
"custom_email": "administrator.admin@rsa.com",
"code_send_to": "EMAIL"
}, {
"email": "dummyUser@support.com",
"custom_email": "noemail@rsa.com",
"code_send_to": "EMAIL"
},
]
Example Response Body After Filtering Duplicate EntriesExample Response Body After Filtering Duplicate Entries [{
"status": 1000,
"errorMessage": "Code Successfully generated. ",
"userDetailsRequestForVerifyCodeGeneration": {
"email": "administrator@support.com",
"custom_email": "administrator.admin@rsa.com",
"code_validity": "10",
"validity_time_duration_unit": "MIN",
"code_send_to": "EMAIL"
}
}, {
"status": 1000,
"errorMessage": "Code Successfully generated. ",
"userDetailsRequestForVerifyCodeGeneration": {
"email": "dummyUser@support.com",
"custom_email": "noemail@rsa.com",
"code_validity": "10",
"validity_time_duration_unit": "MIN",
"code_send_to": "EMAIL"
}
}
]
Response Property DescriptionsResponse Property Descriptions
The following table shows response property descriptions and the associated data types.
Property
Description
Data Type
status
Status of the Response.
Number
userDetailsRequestForVerifyCodeGeneration
Users Details used for generating the code.
Array
verify_code
Code generated for the specified mode.
String
verify_code_validity_time
Expiration time of the code generated.
String
verify_code_generation_mode
Mode of the code generation used.
String
verification_Link
Link to authenticate the user with the generated code.
String
Response CodesResponse Codes
The following table shows response codes and descriptions for this API.
Code
Description
400
Bad request caused by the following: Number of users exceeds maximum allowed value of 100.
{
"code": "400 BAD_REQUEST",
"description": "Number of user details (178) in request exceeds maximum allowed (100)"
}
429
Too many requests.
1000
Successfully generated the code (Secure Enrollment).
1001
Some unexpected internal error. Cannot generate the code.
1002
User is not found /valid for the following reasons:
User is present in Identity Sources but not synced with the Cloud Authentication Service.
User is not present in Identity Sources.
1003
Invalid format of email address.
1004
Request validation error caused by:
Validity duration is less than 0 seconds or greater than 86400 seconds.
Time unit of the Validity is not valid. It must be MIN or HOUR.
Validity duration is not in valid format.
1005
Not able to send the code via Email if the specific option to send the email is not configured properly on the My Account > Company Settings page.
1006
Code Generation for secure enrollment is not possible for the following reasons:
My Page is disabled.
The "Enroll" option is disabled.
The user is disabled.
User has at least a device enrolled, and then the enrollment code cannot be generated.
Previous Page
Next Page
... View more
403 
1689296
