/deactivateUserApiAccess

1 min

POST

Deactivate a user's API access. Only an admin can access this API function. The Id validation of the correct email address should happen in both client and server sides. If deactivating a user will invalidate some of the approval workflows, their IDs will be returned in addition to the SUCCESS status code.

Request Example:

    .. code-block::

        deactivateUserApiAccess(
            deactivationStartTime="1773583701",
            userToDeactivateId="[email protected]"
            )

    ----

    **Response Example:**
    .. code-block::

        {
            "FunctionData": {
                    "Status": "Success"
            },
            "Meta": {
              "AccessToken": "58f08df6e369fa4d126e1ba5c7f66cf85c9c79df32d05fee8f3c542121c87cf5",
              "Destination": "044fd7dc60304b8aceeb662ce41bf9d9cc132278c0871c0a72fb4f3cecbabb25a86e43ae28dab21a95c64e2db76abdcfffb9bfdeec67a21399cfa5f555f01d054b",
              "Source": "be1f60e490b8ccabcc02a4595817b8edf45905d24944e87b8e3cae27f158df63843bfc4b09d37a5e752017b74ea2d136af272bea210f059e768e1ea8777aaf21e9",
              "Time": "2025-10-19 15:04:13.129"
            }
        }

    ----

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Unknown user	"StatusCode": 1
Backend Response	400	2	Users are managed externally	"StatusCode": 2

user_to_deactivate_idstring<p>The ID of the user to have their API access deactivated (the user's email in lower case).</p>

deactivation_start_timestring<p>The start time of the deactivation in UNIX time (optional).</p>

acceptstringGenerated from available response content types

bodyobjectRequest data for deactivating a user.

200success

curl --request POST \
     --url '/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"
     }
     }'