General Information

Service	API	Method	Data Models	Workflow	Group
multitenant	/admin/tenant/application/key	POST	Tenant	N/A	Admin

Description

Add key to a tenant application with optional ext key

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

id

Query

YES

String

N/A

Tenant ID

appId

Body

YES

String

N/A

Application ID

config

Body

NO

Object

Tenant Key Configuration

Key Configuration

extKey

Body

NO

Object

Application External Key

Name	Mandatory	Type	Special Format	Description
label	YES	String	N/A	Key label
env	YES	String	N/A	Environment
expDate	NO	String	date-time	Expiry Date
device	NO	Object	N/A	Device Config
geo	NO	Object	N/A	Geo 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
602	Model error: + %model_error%

Browser not supported