PUT - /admin/tenant/application/key/extKey

General Information

Service	API	Method	Data Models	Workflow
multitenant	/admin/tenant/application/key/extKey	PUT	Tenant	N/A

Description

This API updates the external key that matches the one sent in the request body and exists in the application record and the tenant that have the ids that match the ones sent in the query.

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
key	Body	YES	String	N/A	Key
extKey	Body	YES	String	N/A	External Key
expDate	Body	NO	String	date-time	Expiry date
label	Body	NO	String	N/A	Key Label
extKeyEnv	Body	NO	String	N/A	External Key Environment
device	Body	NO	Object	N/A	Device information
geo	Body	NO	Object	N/A	Geo-Location information

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
500	You cannot modify or delete a locked record
602	Model error: + %model_error%