Add REST API Implementation for fetching Key Manager usages and delete Keys

wso2 / carbon-apimgt

Apache License 2.0

166 stars 626 forks source link

Purpose

Port https://github.com/wso2-support/carbon-apimgt/pull/6065
Related issues: https://github.com/wso2/api-manager/issues/1943
Add REST API Implementation for fetching Key Manager usages (APIs and Applications) and delete Keys
Add Rest API Implementation for Key Manager delete prevention when it is used
Add a new field isUsed to getKeyManagers response.

Description

GET key-managers/{key-manager-id}/api-usages

Sample cURL :

curl 'https://localhost:9443/api/am/admin/v4/key-managers/096c55a5-b447-4c2e-9e9e-7eeae8d9db56/api-usages?offset=0&limit=10' \
-H 'accept: application/json' \
-H 'authorization: Bearer 4999ed52-e2bd-3317' \

Sample response:

{
"apiCount": 2,
"apis": [
    {
        "id": "f66aaff3-4a37-467e-a153-fe0a10cf61d3",
        "type": "API",
        "name": "api1",
        "transportType": "HTTP",
        "description": null,
        "context": "/api1/{version}",
        "version": "v1",
        "provider": "admin",
        "status": "PUBLISHED",
        "thumbnailUri": null,
        "advertiseOnly": false,
        "keyManagerEntry": "Resident Key Manager"
    },
    {
        "id": "574dcb8b-60d1-4576-8416-f7479306b408",
        "type": "API",
        "name": "PizzaShackAPI",
        "transportType": "HTTP",
        "description": "This is a simple API for Pizza Shack online pizza delivery store.",
        "context": "/pizzashack/{version}",
        "version": "1.0.0",
        "provider": "admin",
        "status": "PUBLISHED",
        "thumbnailUri": null,
        "advertiseOnly": false,
        "keyManagerEntry": "auth0Normal , Resident Key Manager"
    }
]
}

GET key-managers/{key-manager-id}/app-usages

Sample cURL :

curl 'https://localhost:9443/api/am/admin/v4/key-managers/096c55a5-b447-4c2e-9e9e-7eeae8d9db56/app-usages?offset=0&limit=10' \
-H 'accept: application/json' \
-H 'authorization: Bearer 4999ed52-e2bd-3317' \

Sample response:

{
"applicationCount": 2,
"applications": [
    {
        "name": "app3",
        "uuid": "08d4b95c-f715-47c4-8588-406d6857a677",
        "organizationId": null,
        "owner": "admin",
        "organization": "carbon.super"
    },
    {
        "name": "app7",
        "uuid": "36817dfa-3934-496f-be9b-632d6274fe26",
        "organizationId": null,
        "owner": "admin",
        "organization": "carbon.super"
    }
]
}

DELETE applications/{application-id}/oauth-keys/{keyMappingId}

Sample cURL :

curl 'https://localhost:9443/api/am/devportal/v3/applications/e6a3875a-1f3a-4d27-af49-401715a821bf/oauth-keys/64a25d15-661e-40d5-a11a-fa6991cea3e1' \
-X 'DELETE' \
-H 'Accept: */*' \
-H 'X-WSO2-Tenant: carbon.super' \
-H 'authorization: Bearer ef77a93e-ae56-3511' \

Files	Patch %	Lines
...gt/rest/api/admin/v1/dto/APIInfoKeyManagerDTO.java	0.00%	110 Missing :warning:
...api/admin/v1/dto/ApplicationInfoKeyManagerDTO.java	0.00%	54 Missing :warning:
...admin/v1/utils/mappings/KeyManagerMappingUtil.java	2.22%	44 Missing :warning:
.../rest/api/admin/v1/dto/KeyManagerAPIUsagesDTO.java	0.00%	30 Missing :warning:
.../rest/api/admin/v1/dto/KeyManagerAppUsagesDTO.java	0.00%	30 Missing :warning:
...a/org/wso2/carbon/apimgt/impl/APIConsumerImpl.java	3.33%	29 Missing :warning:
...ava/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java	17.14%	26 Missing and 3 partials :warning:
...t/api/admin/v1/impl/KeyManagersApiServiceImpl.java	4.16%	23 Missing :warning:
...java/org/wso2/carbon/apimgt/impl/APIAdminImpl.java	56.81%	14 Missing and 5 partials :warning:
.../api/store/v1/impl/ApplicationsApiServiceImpl.java	0.00%	11 Missing :warning:
... and 8 more

Files

Patch %

Lines

...gt/rest/api/admin/v1/dto/APIInfoKeyManagerDTO.java

0.00%

110 Missing :warning:

...api/admin/v1/dto/ApplicationInfoKeyManagerDTO.java

0.00%

54 Missing :warning:

...admin/v1/utils/mappings/KeyManagerMappingUtil.java

2.22%

44 Missing :warning: