Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

General Information

ServiceAPIMethodData ModelsWorkflow
multitenant

/tenant/application/key

POSTTenantN/A

Description

This API adds an application 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.

Input

Type: application/json

NameSourceMandatoryTypeSpecial FormatDescription
appIdBodyYESStringN/AApplication ID
configBodyNOObjectTenant Key ConfigurationKey Configuration
extKeyBodyNOObject
Application External Key

NameMandatoryTypeSpecial FormatDescription
labelYESStringN/AKey label
envYESStringN/AEnvironment
expDateNOStringdate-timeExpiry Date
deviceNOObjectN/ADevice Config
geoNOObjectN/AGeo Location
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

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

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

602Model error: + %model_error%
  • No labels