Key#

class Key(name=None, description=None, key_type=None, created_time=None, last_updated_by=None, creation_type=None, expiry_time=None, status=None, created_by=None, last_updated_time=None, assigned_to=None, last_used_time=None, key_details=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

Credentials in the form of a unique random key for the users.

Parameters:

  • name (required min=1 chars, max=255 chars) – (name) Identifier for the key in the form of a name.

  • description (max=1000 chars) – (description) Brief description of the key.

  • key_type (required) – (key_type)

  • created_time – (created_time) The creation time of the key.

  • last_updated_by – (last_updated_by) User who updated the key.

  • creation_type – (creation_type)

  • expiry_time – (expiry_time) The time when the key will expire.

  • status – (status)

  • created_by – (created_by) User or service who created the key.

  • last_updated_time – (last_updated_time) The time when the key was updated.

  • assigned_to (min=3 chars, max=255 chars) – (assigned_to) External client to whom the given key is allocated.

  • last_used_time – (last_used_time) The time when the key was last used.

  • key_details – (key_details) Details specific to type of the key.

property assigned_to#

External client to whom the given key is allocated.

Type:

str

property created_by#

User or service who created the key.

Type:

str

property created_time#

The creation time of the key.

Type:

datetime

property creation_type#
Type:

CreationType

property description#

Brief description of the key.

Type:

str

property expiry_time#

The time when the key will expire.

Type:

datetime

property key_details#

Details specific to type of the key.

Type:

ApiKeyDetails | ObjectKeyDetails

property key_type#
Type:

KeyKind

property last_updated_by#

User who updated the key.

Type:

str

property last_updated_time#

The time when the key was updated.

Type:

datetime

property last_used_time#

The time when the key was last used.

Type:

datetime

property name#

Identifier for the key in the form of a name.

Type:

str

property status#
Type:

KeyStatus

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model