...
...
...
General Information
...
| Service | API | Method | Data Models | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /tenant/application/extkeykey/ext | PUT | Tenant | N/A | Tenant |
Description
This API updates the external key that matches the one sent in the request body and exists in the application record that has the appId sent in the request body and the tenant that has external key sent in the request headers.Update external key information for a tenant application
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| appId | Body | YES | String | N/A | Application ID |
| key | Body | YES | String | N/A | Key |
| extKey | Body | YES | String | N/A | External Key |
expDate | Body | NO | String | date-time | Expiry date |
| label | Body | NO | String | N/A | Key Label |
extKeyEnv | Body | NO | String | N/A | External Key Environment |
| device | Body | NO | Object | N/A | Device information |
| geo | Body | NO | Object | N/A | Geo-Location information |
Tenant id will automatically be taken from the extKey (tenant logged in from)
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: true
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 450 | Unable to find tenant |
| 471 | Unable to update tenant |
| 500 | You cannot modify or delete a locked record |
| 602 | Model error: + %model_error% |