Delete a KeyPair based on the Alias Name
delete
/oam/services/rest/ssa/api/v1/keypairadmin/keypair
A KeyPair that is currently being made use by an Oauth Identity Domain can never be deleted and a KeyPair under rollover duration cannot be deleted.
Request
Supported Media Types
- application/json
- application/x-www-form-urlencoded
Query Parameters
-
aliasName(required): string
Alias Name of the KeyPair to be deleted.
-
forceDelete: string
Setting this value to 'Y' will forcefully delete a KeyPair that is under rollover duration.
Response
Supported Media Types
- text/plain
200 Response
Sucessfully deleted entity - KeyPair, detail - Successfully deleted NameOfKeyPair
400 Response
Delete failed for KeyPair NameOfKeyPair. NameOfKeyPair not found
Examples
cURL Sample Request
curl--location--request DELETE 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/keypairadmin/keypair?aliasName=NewDomain1' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic dGVzdDp0ZXN0=' \
cURL Sample Response
Sucessfully deleted entity - KeyPair, detail - Successfully deleted NewDomain1