Skip to content

API Key Response Dto

immichpy.client.generated.models.api_key_response_dto.APIKeyResponseDto pydantic-model

Bases: BaseModel

APIKeyResponseDto

Show JSON schema: 
{
  "$defs": {
    "Permission": {
      "description": "List of permissions",
      "enum": [
        "all",
        "activity.create",
        "activity.read",
        "activity.update",
        "activity.delete",
        "activity.statistics",
        "apiKey.create",
        "apiKey.read",
        "apiKey.update",
        "apiKey.delete",
        "asset.read",
        "asset.update",
        "asset.delete",
        "asset.statistics",
        "asset.share",
        "asset.view",
        "asset.download",
        "asset.upload",
        "asset.replace",
        "asset.copy",
        "asset.derive",
        "asset.edit.get",
        "asset.edit.create",
        "asset.edit.delete",
        "album.create",
        "album.read",
        "album.update",
        "album.delete",
        "album.statistics",
        "album.share",
        "album.download",
        "albumAsset.create",
        "albumAsset.delete",
        "albumUser.create",
        "albumUser.update",
        "albumUser.delete",
        "auth.changePassword",
        "authDevice.delete",
        "archive.read",
        "backup.list",
        "backup.download",
        "backup.upload",
        "backup.delete",
        "duplicate.read",
        "duplicate.delete",
        "face.create",
        "face.read",
        "face.update",
        "face.delete",
        "folder.read",
        "job.create",
        "job.read",
        "library.create",
        "library.read",
        "library.update",
        "library.delete",
        "library.statistics",
        "timeline.read",
        "timeline.download",
        "maintenance",
        "map.read",
        "map.search",
        "memory.create",
        "memory.read",
        "memory.update",
        "memory.delete",
        "memory.statistics",
        "memoryAsset.create",
        "memoryAsset.delete",
        "notification.create",
        "notification.read",
        "notification.update",
        "notification.delete",
        "partner.create",
        "partner.read",
        "partner.update",
        "partner.delete",
        "person.create",
        "person.read",
        "person.update",
        "person.delete",
        "person.statistics",
        "person.merge",
        "person.reassign",
        "pinCode.create",
        "pinCode.update",
        "pinCode.delete",
        "plugin.create",
        "plugin.read",
        "plugin.update",
        "plugin.delete",
        "server.about",
        "server.apkLinks",
        "server.storage",
        "server.statistics",
        "server.versionCheck",
        "serverLicense.read",
        "serverLicense.update",
        "serverLicense.delete",
        "session.create",
        "session.read",
        "session.update",
        "session.delete",
        "session.lock",
        "sharedLink.create",
        "sharedLink.read",
        "sharedLink.update",
        "sharedLink.delete",
        "stack.create",
        "stack.read",
        "stack.update",
        "stack.delete",
        "sync.stream",
        "syncCheckpoint.read",
        "syncCheckpoint.update",
        "syncCheckpoint.delete",
        "systemConfig.read",
        "systemConfig.update",
        "systemMetadata.read",
        "systemMetadata.update",
        "tag.create",
        "tag.read",
        "tag.update",
        "tag.delete",
        "tag.asset",
        "user.read",
        "user.update",
        "userLicense.create",
        "userLicense.read",
        "userLicense.update",
        "userLicense.delete",
        "userOnboarding.read",
        "userOnboarding.update",
        "userOnboarding.delete",
        "userPreference.read",
        "userPreference.update",
        "userProfileImage.create",
        "userProfileImage.read",
        "userProfileImage.update",
        "userProfileImage.delete",
        "queue.read",
        "queue.update",
        "queueJob.create",
        "queueJob.read",
        "queueJob.update",
        "queueJob.delete",
        "workflow.create",
        "workflow.read",
        "workflow.update",
        "workflow.delete",
        "adminUser.create",
        "adminUser.read",
        "adminUser.update",
        "adminUser.delete",
        "adminSession.read",
        "adminAuth.unlinkAll"
      ],
      "title": "Permission",
      "type": "string"
    }
  },
  "description": "APIKeyResponseDto",
  "properties": {
    "createdAt": {
      "description": "Creation date",
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "id": {
      "description": "API key ID",
      "title": "Id",
      "type": "string"
    },
    "name": {
      "description": "API key name",
      "title": "Name",
      "type": "string"
    },
    "permissions": {
      "description": "List of permissions",
      "items": {
        "$ref": "#/$defs/Permission"
      },
      "title": "Permissions",
      "type": "array"
    },
    "updatedAt": {
      "description": "Last update date",
      "format": "date-time",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "createdAt",
    "id",
    "name",
    "permissions",
    "updatedAt"
  ],
  "title": "APIKeyResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

created_at pydantic-field 

created_at: datetime

Creation date

id pydantic-field 

id: StrictStr

API key ID

name pydantic-field 

name: StrictStr

API key name

permissions pydantic-field 

permissions: List[Permission]

List of permissions

updated_at pydantic-field 

updated_at: datetime

Last update date

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of APIKeyResponseDto from a dict

Source code in immichpy/client/generated/models/api_key_response_dto.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of APIKeyResponseDto from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate(
        {
            "createdAt": obj.get("createdAt"),
            "id": obj.get("id"),
            "name": obj.get("name"),
            "permissions": obj.get("permissions"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of APIKeyResponseDto from a JSON string

Source code in immichpy/client/generated/models/api_key_response_dto.py 
60
61
62
63
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of APIKeyResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Source code in immichpy/client/generated/models/api_key_response_dto.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def to_dict(self) -> Dict[str, Any]:
    """Return the dictionary representation of the model using alias.

    This has the following differences from calling pydantic's
    `self.model_dump(by_alias=True)`:

    * `None` is only added to the output dict for nullable fields that
      were set at model initialization. Other fields with value `None`
      are ignored.
    """
    excluded_fields: Set[str] = set([])

    _dict = self.model_dump(
        by_alias=True,
        exclude=excluded_fields,
        exclude_none=True,
    )
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/api_key_response_dto.py 
55
56
57
58
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
    return json.dumps(self.to_dict())

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/api_key_response_dto.py 
51
52
53
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))