/deactivateUserApiAccess
1 min
POST
http://1.1.1.1/deactivateUserApiAccess
user_to_deactivate_idstringThe ID of the user to have his API access deactivated
deactivation_start_timestring<p>(optional argument) - The Start Time of the deactivation in UNIX time</p>
<ul>
<li>The required format is the number of seconds since epoch (January 1, 1970, 00:00:00 at UTC) until the start time.</li>
<li>The default value for deactivation_start_time is the time-stamp of the request.</li>
</ul>
bodyobjectRequest data for deactivating a user.
200success
curl --request POST \
--url 'http://1.1.1.1/deactivateUserApiAccess?user_to_deactivate_id=bob%40gk8.io&deactivation_start_time=1644239621' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data-raw '{
"FunctionData": {
"DeactivationStartTime": "1644239621",
"UserToDeactivateId": "[email protected]"
},
"Meta": {
"FunctionName": "deactivateUserApiAccess",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
}'- deactivateUserApiAccess - only an admin can access this API function.
- This function deactivating a user's API access, typically used by an admin
- return - response a confirmation Json.
- Status: The status of this operation (Success/Failed)
- Possible status codes:
0 - User disabled successfully, 1 - Unknown user