POST - /admin/tenant/application/key

Owned by Fadi Nasr (Unlicensed)
Last updated: Sept 07, 2020 by Ragheb Bou Dargham (Unlicensed)

General Information

ServiceAPIMethodData ModelsWorkflowGroup
multitenant

/admin/tenant/application/key

POSTTenantN/AAdmin

Description

Add key to a tenant application with optional ext key

Input

Type: application/json

NameSourceMandatoryTypeSpecial FormatDescription
idQueryYESStringN/ATenant ID
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


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%