api-key.md

Api Key

api_key_controller = client.api_key

Class Name

ApiKeyController

Methods

• Create Key
• Get Keys
• Revoke Key

Create Key

Create a new api key.

def create_key(self,
              app)

Parameters

Parameter	Type	Tags	Description
app	string	Query, Required	Name of the app using the authentication key.

Response Type

void

Example Usage

app = 'app2'

result = api_key_controller.create_key(app)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Get Keys

Get all keys.

def get_keys(self)

Response Type

AuthenticationInfoQueryResult

Example Usage

result = api_key_controller.get_keys()

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException

Revoke Key

Remove an api key.

def revoke_key(self,
              key)

Parameters

Parameter	Type	Tags	Description
key	string	Template, Required	The access token to delete.

Response Type

void

Example Usage

key = 'key0'

result = api_key_controller.revoke_key(key)

Errors

HTTP Status Code	Error Description	Exception Class
401	Unauthorized	APIException
403	Forbidden	APIException