How to manage appkey

For some applications such as those which are built to distribute reserved content, to perform workflow operations or to impersonate business users, it is recommended to increase the level of security in the authentication process of the application itself. This can be done thanks to a secret code generated by the platform, the appkey which, once created, will be used to perform any request involving the application.

In order to generate an appkey and link it to a specific application, the first thing to do is to retrieve the appId of the application. This can be done with a appsList request, in the body you can paste the following JSON, filling required parameters:

{
    "clientId": "",
    "criteria": {
        "onlyMyApps": false
    }
}

In the response you will get a list of applications, identify the one you want to generate the key for and save its appId.

Now you can generate a new appKey with a generateKey request which is included in the appsadmin package of xadmin. This request can be performed only by administrators of the application itself, you can generate up to 10 keys for each application; remember to include the previously stored appId in the body of the request, which is structured as follows:

{
    "appId": "",
    "value": {
        "active": true
    }
}

If you wish to disable an appKey at any time you can do it by performing an updateKey request, setting the "active" parameter to false; this request can be performed only by app's administrators:

{
    "appId": "",
    "key": "",
    "value": {
        "active": false
    }
}

To remove a specific appKey use the removeKey request, which can be invoked by app's administrators:

{
    "appId": "",
    "key": ""
}
Was this article helpful?
0 out of 0 found this helpful

Have more questions?

SUBMIT A REQUEST

Hai altre domande?

INOLTRA UNA RICHIESTA

Comments