Skip to content

Api Key Create Response Dto

immichpy.client.generated.models.api_key_create_response_dto.ApiKeyCreateResponseDto pydantic-model

Bases: BaseModel

ApiKeyCreateResponseDto

Show JSON schema: 
{
  "$defs": {
    "ApiKeyResponseDto": {
      "description": "ApiKeyResponseDto",
      "properties": {
        "createdAt": {
          "description": "Creation date",
          "examples": [
            "2024-01-01T00:00:00Z"
          ],
          "format": "date-time",
          "title": "Createdat",
          "type": "string"
        },
        "id": {
          "description": "API key ID",
          "format": "uuid",
          "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",
          "examples": [
            "2024-01-01T00:00:00Z"
          ],
          "format": "date-time",
          "title": "Updatedat",
          "type": "string"
        }
      },
      "required": [
        "createdAt",
        "id",
        "name",
        "permissions",
        "updatedAt"
      ],
      "title": "ApiKeyResponseDto",
      "type": "object"
    },
    "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",
        "apiKey.rotate",
        "asset.read",
        "asset.update",
        "asset.delete",
        "asset.statistics",
        "asset.share",
        "asset.view",
        "asset.download",
        "asset.upload",
        "asset.copy",
        "asset.derive",
        "assetFile.read",
        "assetFile.delete",
        "assetFile.download",
        "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",
        "clusterGroup.read",
        "clusterGroup.leave",
        "clusterGroupRequest.create",
        "clusterGroupRequest.read",
        "clusterGroupRequest.delete",
        "adminConfig.read",
        "adminConfig.update",
        "userConfig.read",
        "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",
        "workflow.logs",
        "adminUser.create",
        "adminUser.read",
        "adminUser.update",
        "adminUser.delete",
        "adminSession.read",
        "adminAuth.unlinkAll"
      ],
      "title": "Permission",
      "type": "string"
    }
  },
  "description": "ApiKeyCreateResponseDto",
  "properties": {
    "apiKey": {
      "$ref": "#/$defs/ApiKeyResponseDto"
    },
    "createdAt": {
      "description": "Creation date",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "id": {
      "description": "API key ID",
      "format": "uuid",
      "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"
    },
    "secret": {
      "description": "API key secret (only shown once)",
      "title": "Secret",
      "type": "string"
    },
    "updatedAt": {
      "description": "Last update date",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "apiKey",
    "createdAt",
    "id",
    "name",
    "permissions",
    "secret",
    "updatedAt"
  ],
  "title": "ApiKeyCreateResponseDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

created_at pydantic-field 

created_at: datetime

Creation date

id pydantic-field 

id: UUID

API key ID

name pydantic-field 

name: StrictStr

API key name

permissions pydantic-field 

permissions: List[Permission]

List of permissions

secret pydantic-field 

secret: StrictStr

API key secret (only shown once)

updated_at pydantic-field 

updated_at: datetime

Last update date

created_at_validate_regular_expression pydantic-validator 

created_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/api_key_create_response_dto.py 
60
61
62
63
64
65
66
67
68
69
70
@field_validator("created_at", mode="before")
def created_at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value

from_dict classmethod 

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

Create an instance of ApiKeyCreateResponseDto from a dict

Source code in immichpy/client/generated/models/api_key_create_response_dto.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of ApiKeyCreateResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "apiKey": ApiKeyResponseDto.from_dict(obj["apiKey"])
            if obj.get("apiKey") is not None
            else None,
            "createdAt": obj.get("createdAt"),
            "id": obj.get("id"),
            "name": obj.get("name"),
            "permissions": obj.get("permissions"),
            "secret": obj.get("secret"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of ApiKeyCreateResponseDto from a JSON string

Source code in immichpy/client/generated/models/api_key_create_response_dto.py 
111
112
113
114
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of ApiKeyCreateResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

id_validate_regular_expression pydantic-validator 

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/api_key_create_response_dto.py 
72
73
74
75
76
77
78
79
80
81
82
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

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_create_response_dto.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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,
    )
    # override the default output from pydantic by calling `to_dict()` of api_key
    if self.api_key:
        _dict["apiKey"] = self.api_key.to_dict()
    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_create_response_dto.py 
107
108
109
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(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_create_response_dto.py 
103
104
105
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))

updated_at_validate_regular_expression pydantic-validator 

updated_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/api_key_create_response_dto.py 
84
85
86
87
88
89
90
91
92
93
94
@field_validator("updated_at", mode="before")
def updated_at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value