apiKey_delete.rst

apiKey_delete

.. function:: DELETE /users/{uid}/apikeys/{akid}

Summary

• Method: DELETE
• Response Code: 204 / 200
• Response Formats:
• Since: UForge 3.0

Deletes an API key from the specified user.

Security Summary

• Requires Authentication: true
• Entitlements Required: api_key_access

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object`
• akid (required): the id of the :ref:`apikeypair-object` to delete

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/apikeys/{akid}" -X DELETE \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

         * :ref:`apiKey-create`
         * :ref:`apiKey-getAll`
         * :ref:`apiKey-update`
         * :ref:`apikeypairs-object`
         * :ref:`user-object`