...
...
General Information
...
| Service | API | Method | Data Models | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /tenant/application/key | POST | Tenant | N/A | Tenant |
Description
This API adds an application Add key to the tenant that has external key send in the request headers. The application key will be added under the app that has the appId sent in the request body.a tenant application with optional ext key
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| appId | Body | YES | String | N/A | Application ID | ||||||||||||||||||||||||||||||
| config | Body | NO | Object | Tenant Key Configuration | Key Configuration | ||||||||||||||||||||||||||||||
| extKey | Body | NO | Object | Application External Key | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Tenant id will automatically be taken from the extKey provided (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 |
| 472 | Unable to get the tenant application |
| 500 | You cannot modify or delete a locked record |
| 501 | Environment record not found! |
| 502 | Unable to create External key |
| 602 | Model error: + %model_error% |