PUT - /tenant/application/key/ext
General Information
Service | API | Method | Data Models | Workflow | Group |
---|---|---|---|---|---|
multitenant | /tenant/application/key/ext | PUT | N/A | Tenant |
Description
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
Valid Response Sample
{
result: true,
data: true
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
}
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
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% |