How to Delete an Entity

[shiva-rakshith]

I do not find an API endpoint to delete an entity, Do we have any delete API?

Thanks!

[shiva-rakshith]

Hi Team,
How to delete an entity? Do we have any API or any way to perform a soft deletion by changing the status something like to Revoked or Retired.
Kindly provide your inputs on this. Thanks!

cc: @vrayulu @maheshkumargangula

[pramodkvarma]

You mean deleting a record in the registry? That should be part of CRUD APIs, not sure if all are exposed. @dileepbapat ?

[dileepbapat]

delete api is available (soft delete) as part of base api (we can add restful DELETE verb based api if needed), However the is the usecase of revoke and reissue? it can be just update request in that case.

needs property registry.baseAPIS.enable

POST /delete
{
  "id": "open-saber.registry.delete",
  "ver": "1.0",
  "request": {
      ...
  }
}```

[pramodkvarma]

Registries maintaining certificates etc typically require soft delete. But if registry is about other subjects (say something like blood donor registry) then users who want to delete their account should have that option (under, say, right to be forgotten case). So registry providers typically need both APIs within the framework. Whether they will use it or not depending in the type of registry being maintained.

[shiva-rakshith]

Hi @dileepbapat
What are all the properties that should be passed in request body?
I have set registry.baseAPIS.enable to true and called the /delete API with the following request body, but getting error We are sorry... Client not found.

Logs:

13:30:37.675 [http-nio-8081-exec-6] DEBUG o.k.a.t.AbstractAuthenticatedActionsValve:57 - AuthenticatedActionsValve.invoke /delete
13:30:37.676 [http-nio-8081-exec-6] DEBUG o.k.a.AuthenticatedActionsHandler:53 - AuthenticatedActionsValve.invoke http://localhost:8081/delete
13:30:37.679 [http-nio-8081-exec-6] DEBUG o.k.a.AuthenticatedActionsHandler:153 - Policy enforcement is disabled.
13:30:37.680 [http-nio-8081-exec-6] DEBUG o.k.adapters.PreAuthActionsHandler:74 - adminRequest http://localhost:8081/delete
13:30:37.682 [http-nio-8081-exec-6] DEBUG o.k.a.s.a.KeycloakAuthenticationEntryPoint:116 - Redirecting to login URI /sso/login
13:30:37.685 [http-nio-8081-exec-7] DEBUG o.k.adapters.PreAuthActionsHandler:74 - adminRequest http://localhost:8081/sso/login
13:30:37.686 [http-nio-8081-exec-7] DEBUG o.k.a.t.AbstractAuthenticatedActionsValve:57 - AuthenticatedActionsValve.invoke /sso/login
13:30:37.686 [http-nio-8081-exec-7] DEBUG o.k.a.AuthenticatedActionsHandler:53 - AuthenticatedActionsValve.invoke http://localhost:8081/sso/login
13:30:37.687 [http-nio-8081-exec-7] DEBUG o.k.a.AuthenticatedActionsHandler:153 - Policy enforcement is disabled.
13:30:37.688 [http-nio-8081-exec-7] DEBUG o.k.adapters.PreAuthActionsHandler:74 - adminRequest http://localhost:8081/sso/login
13:30:37.689 [http-nio-8081-exec-7] DEBUG o.k.a.s.f.KeycloakAuthenticationProcessingFilter:206 - Request is to process authentication
13:30:37.689 [http-nio-8081-exec-7] DEBUG o.k.a.s.f.KeycloakAuthenticationProcessingFilter:142 - Attempting Keycloak authentication
13:30:37.690 [http-nio-8081-exec-7] DEBUG o.k.a.s.t.SpringSecurityTokenStore:64 - Checking if org.keycloak.adapters.springsecurity.authentication.SpringSecurityRequestAuthenticator@15cecd7d is cached
13:30:37.691 [http-nio-8081-exec-7] DEBUG o.k.a.OAuthRequestAuthenticator:266 - there was no code
13:30:37.692 [http-nio-8081-exec-7] DEBUG o.k.a.OAuthRequestAuthenticator:274 - redirecting to auth server
13:30:37.693 [http-nio-8081-exec-7] DEBUG o.k.a.OAuthRequestAuthenticator:144 - callback uri: http://localhost:8081/sso/login
13:30:37.694 [http-nio-8081-exec-7] DEBUG o.k.a.s.f.KeycloakAuthenticationProcessingFilter:155 - Auth outcome: NOT_ATTEMPTED
13:30:37.698 [http-nio-8081-exec-7] DEBUG o.k.a.OAuthRequestAuthenticator:227 - Sending redirect to login page: http://localhost:8080/auth/realms/sunbird-rc/protocol/openid-connect/auth?response_type=code&client_id=client&redirect_uri=http%3A%2F%2Flocalhost%3A8081%2Fsso%2Flogin&state=fd381607-5dc8-4785-8e1b-81916fc39b55&login=true&scope=openid

[tejash-jl]

@shiva-rakshith
you can use DELETE API. This api will do a soft delete.

curl --location --request DELETE 'http://localhost:8081/api/v1/<entity_name>/<entity_osid>'

[shiva-rakshith]

@tejash-jl - Thanks for your response.

[shiva-rakshith]

@tejash-jl - As this is a soft delete, do we have any API to revoke it?

[tejash-jl]

when you say revoke, do you mean to undo the delete?
If so, then currently we don't have it.

[shiva-rakshith]

Ok, Thanks.