Use the DELETE /sp/tokenGenerators/{{tokenGenId}}
endpoint to delete a token generator instance with the specified ID. A 404 status code is returned for nonexistent IDs.
Only token generators not in use can be deleted. If the request succeeds, the response body is empty. If the request fails, an ApiResult is returned with details of the error.
Path parameters
Parameter |
Value |
Description |
tokenGenId |
string (required) |
ID of a token generator instance to delete. |
Error status codes
Code |
Reason |
204 |
Token generator deleted. |
403 |
PingFederate does not have its IdP role enabled. Operation not available. |
404 |
Resource not found. |
422 |
Resource is in use and cannot be deleted. |
Class models
ApiResult
- Details on the result of the operation.
Property |
Type |
Description |
developerMessage |
string |
Developer-oriented error message, if available. |
message |
string |
Success or error message. |
resultId |
string |
Result identifier. |
validationErrors |
array[ValidationError] |
List of validation errors, if any. |
ValidationError
- A data input validation error.
Property |
Type |
Description |
developerMessage |
string |
Developer-oriented error message, if available. |
errorId |
string |
Error identifier. |
fieldPath |
string |
The path to the model field to which the error relates, if one exists. |
message |
string |
User-friendly error description. |