1) Creating and Deleting Company-Specific App Services in Security365
Creating an App Service
API
| Method | URL |
|---|---|
| POST | /api/{company-id}/client/addClientInfo |
URI Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| company-id | required | string | company-id registered with the Security365 SHIELD ID service |
Request Header
| Name | Required | Description |
|---|---|---|
| Authorization | required | User authentication method, JWT value Authorization: Bearer {JWT}Note: The JWT value is issued through the authentication/authorization service. |
Response
| Name | Type | Description |
|---|---|---|
| errorCode | integer | App Registration (0: Success) |
| msg | string | Response content |
Examples
Response
- App service creation successful
{
"code": 0,
"message" : "App Service Addition Successful"
}
- Already Registered Services
{
"code": 19,
"message" : "Duplicate app services"
}
- App service creation failed
{
"code": 1,
"message" : "An unexpected error has occurred in the internal system"
}
- Failed to update appId, appSecret
{
"code": 50001,
"error": "Failed",
"message" : "BuiltIn Profile Update failed"
}
Delete App Service
API
| Method | URL |
|---|---|
| POST | /api/{company-id}/client/deleteClientInfo |
URI Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| company-id | required | string | company-id registered with the Security365 SHIELD ID service |
Request Header
| Name | Required | Description |
|---|---|---|
| Authorization | required | User authentication method, JWT value Authorization: Bearer {JWT}Note: The JWT value is issued through the authentication/authorization service. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| clientId | required | string | App service Id to be removed |
Response
| Name | Type | Description |
|---|---|---|
| errorCode | integer | App Registration (0: Success) |
| msg | string | Response content |
Examples
Response
- App service deletion successful
{
"code": 0,
"message" : "App Service Delete Successful"
}
- Failed to delete app service
{
"code": 19,
"message" : "App Service Delete Failed"
}