---
title: /deactivateUserApiAccess
slug: mihai-tests/deactivateuserapiaccess
createdAt: 2024-01-09T12:30:00.566Z
---

{
  "id": "gbMiVKSJTqhpIiACKOBZv",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/deactivateUserApiAccess",
    "servers": [
      {
        "url": "http://1.1.1.1/deactivateUserApiAccess"
      }
    ],
    "name": "",
    "description": "<ul>\n<li>\n<p>deactivateUserApiAccess - only an admin can access this API function.</p>\n</li>\n<li>\n<p>This function deactivating a user's API access, typically used by an admin</p>\n</li>\n<li>\n<p>return - response a confirmation Json.</p>\n</li>\n</ul>\n<ul>\n<li>Status: The status of this operation (Success/Failed)</li>\n</ul>\n<ul>\n<li>Possible status codes:</li>\n</ul>\n<p>0 - User disabled successfully,\n1 - Unknown user</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "required",
          "name": "user_to_deactivate_id",
          "type": "string",
          "example": "bob@gk8.io",
          "description": "The ID of the user to have his API access deactivated",
          "default": "bob@gk8.io"
        },
        {
          "kind": "optional",
          "name": "deactivation_start_time",
          "type": "string",
          "example": "1644239621",
          "description": "<p>(optional argument) - The Start Time of the deactivation in UNIX time</p>\n<ul>\n<li>The required format is the number of seconds since epoch (January 1, 1970, 00:00:00 at UTC) until the start time.</li>\n<li>The default value for deactivation_start_time is the time-stamp of the request.</li>\n</ul>",
          "default": "1644239621"
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "description": "Request data for deactivating a user.",
          "customType": "deactivateUserApiAccessRequest",
          "schema": [
            {
              "name": "FunctionData",
              "kind": "optional",
              "type": "object",
              "description": "Contains the function-specific data.",
              "example": "",
              "schema": [
                {
                  "name": "DeactivationStartTime",
                  "kind": "optional",
                  "type": "string",
                  "description": "The start time for deactivation.",
                  "example": "1644239621",
                  "default": "1644239621"
                },
                {
                  "name": "UserToDeactivateId",
                  "kind": "optional",
                  "type": "string",
                  "description": "The user's ID to deactivate.",
                  "example": "bob@gk8.io",
                  "default": "bob@gk8.io"
                }
              ]
            },
            {
              "name": "Meta",
              "kind": "optional",
              "type": "object",
              "modelRef": "#/components/schemas/MetaTokendeactivateUserApiAccess",
              "customType": "MetaTokendeactivateUserApiAccess",
              "schema": [
                {
                  "name": "FunctionName",
                  "kind": "optional",
                  "type": "string",
                  "description": "The Function to be called",
                  "example": "deactivateUserApiAccess",
                  "default": "deactivateUserApiAccess"
                },
                {
                  "name": "RandomData",
                  "kind": "optional",
                  "type": "string",
                  "description": "Random Data",
                  "example": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
                  "default": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229"
                },
                {
                  "name": "Destination",
                  "kind": "optional",
                  "type": "string",
                  "description": "Id of the server",
                  "example": "",
                  "default": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea"
                },
                {
                  "name": "Time",
                  "kind": "optional",
                  "type": "string",
                  "description": "UTC Time of execution",
                  "example": "2021-02-07T18:37:46.948Z",
                  "default": "2021-02-07T18:37:46.948Z"
                },
                {
                  "name": "Source",
                  "kind": "optional",
                  "type": "string",
                  "description": "User public key",
                  "example": "",
                  "default": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99"
                },
                {
                  "name": "AccessToken",
                  "kind": "optional",
                  "type": "string",
                  "description": "Token used for authentication purposes",
                  "example": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087",
                  "default": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/deactivateUserApiAccessRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "example": "",
                "schema": [
                  {
                    "name": "Status",
                    "kind": "optional",
                    "type": "string",
                    "description": "The status of this operation (Success/Failed)",
                    "example": "Success",
                    "default": "Success"
                  }
                ]
              },
              {
                "name": "Meta",
                "kind": "optional",
                "type": "object",
                "modelRef": "#/components/schemas/MetaResponse",
                "customType": "MetaResponse",
                "schema": [
                  {
                    "name": "AccessToken",
                    "kind": "optional",
                    "type": "string",
                    "description": "The new access token generated after this operation",
                    "example": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
                    "default": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6"
                  },
                  {
                    "name": "Destination",
                    "kind": "optional",
                    "type": "string",
                    "description": "Id of the server",
                    "example": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
                    "default": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622"
                  },
                  {
                    "name": "Source",
                    "kind": "optional",
                    "type": "string",
                    "description": "User public key",
                    "example": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
                    "default": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355"
                  },
                  {
                    "name": "Time",
                    "kind": "optional",
                    "type": "string",
                    "description": "UTC Time of execution",
                    "example": "2021-02-14 09:58:52.320",
                    "default": "2021-02-14 09:58:52.320"
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url 'http://1.1.1.1/deactivateUserApiAccess?user_to_deactivate_id=bob%40gk8.io&deactivation_start_time=1644239621' \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data-raw '{\n     \"FunctionData\": {\n     \"DeactivationStartTime\": \"1644239621\",\n     \"UserToDeactivateId\": \"bob@gk8.io\"\n     },\n     \"Meta\": {\n     \"FunctionName\": \"deactivateUserApiAccess\",\n     \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n     \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n     \"Time\": \"2021-02-07T18:37:46.948Z\",\n     \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n     \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n     }\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"FunctionData\": {\n      \"DeactivationStartTime\": \"1644239621\",\n      \"UserToDeactivateId\": \"bob@gk8.io\"\n   },\n   \"Meta\": {\n      \"FunctionName\": \"deactivateUserApiAccess\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"http://1.1.1.1/deactivateUserApiAccess?user_to_deactivate_id=bob@gk8.io&deactivation_start_time=1644239621\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://1.1.1.1/deactivateUserApiAccess?user_to_deactivate_id=bob@gk8.io&deactivation_start_time=1644239621\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"FunctionData\": {\n      \"DeactivationStartTime\": \"1644239621\",\n      \"UserToDeactivateId\": \"bob@gk8.io\"\n   },\n   \"Meta\": {\n      \"FunctionName\": \"deactivateUserApiAccess\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"http://1.1.1.1/deactivateUserApiAccess?user_to_deactivate_id=bob@gk8.io&deactivation_start_time=1644239621\"\n\npayload = json.dumps({\n   \"FunctionData\": {\n      \"DeactivationStartTime\": \"1644239621\",\n      \"UserToDeactivateId\": \"bob@gk8.io\"\n   },\n   \"Meta\": {\n      \"FunctionName\": \"deactivateUserApiAccess\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// success\n{\n  \"FunctionData\": {\n    \"Status\": \"Success\"\n  },\n  \"Meta\": {\n    \"AccessToken\": \"a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6\",\n    \"Destination\": \"042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622\",\n    \"Source\": \"df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355\",\n    \"Time\": \"2021-02-14 09:58:52.320\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "g5VayY3aN1nkqBO2hEiEF",
      "type": "bulleted-list",
      "children": [
        {
          "id": "4V80v4eZNZlLksZG3WQjk",
          "type": "list-item",
          "children": [
            {
              "id": "EHZKQiF8DTcV0Qinnj2fU",
              "type": "list-item-child",
              "children": [
                {
                  "text": "deactivateUserApiAccess - only an admin can access this API function."
                }
              ]
            }
          ]
        },
        {
          "id": "i-SISon2PaCZiFN_W1n9y",
          "type": "list-item",
          "children": [
            {
              "id": "JvDJO_MygNSARIM3Qqvwj",
              "type": "list-item-child",
              "children": [
                {
                  "text": "This function deactivating a user's API access, typically used by an admin"
                }
              ]
            }
          ]
        },
        {
          "id": "sikVP3k15ON9XV6kg7iRE",
          "type": "list-item",
          "children": [
            {
              "id": "Z_f0bFkXyePlG16QMgolE",
              "type": "list-item-child",
              "children": [
                {
                  "text": "return - response a confirmation Json."
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "rE53WS5KYNRnhr6wDG6-A",
      "type": "bulleted-list",
      "children": [
        {
          "id": "nFfNa4tmb3YdVfku9eFnc",
          "type": "list-item",
          "children": [
            {
              "id": "emfwWfw5GYKPwk63oZL_T",
              "type": "list-item-child",
              "children": [
                {
                  "text": "Status: The status of this operation (Success/Failed)"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "KOeeejrgZg8Ya2_O3ryjW",
      "type": "bulleted-list",
      "children": [
        {
          "id": "WhfsaV665YaQExgEGDCcm",
          "type": "list-item",
          "children": [
            {
              "id": "oXqWiABXn9_LxgIrN15yY",
              "type": "list-item-child",
              "children": [
                {
                  "text": "Possible status codes:"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "6wgnnwOXRa1BUrsxfQZyE",
      "type": "paragraph",
      "children": [
        {
          "text": "0 - User disabled successfully,\n1 - Unknown user"
        }
      ]
    }
  ]
}