api_keys¶

The following methods allow for interaction with the ZTW Provisioning API Key API endpoints.

Methods are accessible via ztw.api_keys

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class ProvisioningAPIKeyAPI¶

Bases: APIClient

A Client object for the ProvisioningAPIKeyAPI resource.

list_api_keys(query_params=None)¶

List all existing API keys.

Keyword Arguments:

query_params (dict) –

Map of query parameters for the request.

[query_params.include_partner_keys] (bool): Include or exclude partner keys from the list.

Returns:

The list of API keys.

Return type:

Tuple

Examples

List all API keys:

for api_key in ztw.admin.list_api_keys():
    print(api_key)

regenerate_api_key(key_id, **kwargs)¶

Regenerate the specified API key.

Parameters:: key_id (str) – The ID of the API key to regenerate.
Returns:: The regenerated API key.
Return type:: Tuple

Examples

Regenerate an API key:

print(ztw.admin.regenerate_api_key("123456789"))