Add Tenant Application External Key

General Information

Service	API	Method	Data Models	Workflow
multitenant	/tenant/application/key/ext	POST	Tenant	N/A

Description

This API adds an application external key to the tenant that has the external key sent in the request headers. The application external key will be added under the app that has the appId and the internal key that matches the one sent in the request body.

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
appId	Body	YES	String	N/A	Application ID
key	Body	YES	Object	N/A	Application Key
label	Body	YES	String	N/A	Key Label
env	Body	YES	String	N/A	Environment Name
expDate	Body	NO	String	date-time	expiry Date
device	Body	NO	Object	N/A	Device config
geo	Body	NO	Object	N/A	Geo 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
473	Unable to get the tenant application key
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%