Skip to content

System Config O Auth Dto

immichpy.client.generated.models.system_config_o_auth_dto.SystemConfigOAuthDto pydantic-model

Bases: BaseModel

SystemConfigOAuthDto

Show JSON schema: 
{
  "$defs": {
    "OAuthTokenEndpointAuthMethod": {
      "description": "Token endpoint auth method",
      "enum": [
        "client_secret_post",
        "client_secret_basic"
      ],
      "title": "OAuthTokenEndpointAuthMethod",
      "type": "string"
    }
  },
  "description": "SystemConfigOAuthDto",
  "properties": {
    "autoLaunch": {
      "description": "Auto launch",
      "title": "Autolaunch",
      "type": "boolean"
    },
    "autoRegister": {
      "description": "Auto register",
      "title": "Autoregister",
      "type": "boolean"
    },
    "buttonText": {
      "description": "Button text",
      "title": "Buttontext",
      "type": "string"
    },
    "clientId": {
      "description": "Client ID",
      "title": "Clientid",
      "type": "string"
    },
    "clientSecret": {
      "description": "Client secret",
      "title": "Clientsecret",
      "type": "string"
    },
    "defaultStorageQuota": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Default storage quota",
      "title": "Defaultstoragequota"
    },
    "enabled": {
      "description": "Enabled",
      "title": "Enabled",
      "type": "boolean"
    },
    "issuerUrl": {
      "description": "Issuer URL",
      "title": "Issuerurl",
      "type": "string"
    },
    "mobileOverrideEnabled": {
      "description": "Mobile override enabled",
      "title": "Mobileoverrideenabled",
      "type": "boolean"
    },
    "mobileRedirectUri": {
      "description": "Mobile redirect URI",
      "title": "Mobileredirecturi",
      "type": "string"
    },
    "profileSigningAlgorithm": {
      "description": "Profile signing algorithm",
      "title": "Profilesigningalgorithm",
      "type": "string"
    },
    "roleClaim": {
      "description": "Role claim",
      "title": "Roleclaim",
      "type": "string"
    },
    "scope": {
      "description": "Scope",
      "title": "Scope",
      "type": "string"
    },
    "signingAlgorithm": {
      "title": "Signingalgorithm",
      "type": "string"
    },
    "storageLabelClaim": {
      "description": "Storage label claim",
      "title": "Storagelabelclaim",
      "type": "string"
    },
    "storageQuotaClaim": {
      "description": "Storage quota claim",
      "title": "Storagequotaclaim",
      "type": "string"
    },
    "timeout": {
      "description": "Timeout",
      "minimum": 1,
      "title": "Timeout",
      "type": "integer"
    },
    "tokenEndpointAuthMethod": {
      "$ref": "#/$defs/OAuthTokenEndpointAuthMethod"
    }
  },
  "required": [
    "autoLaunch",
    "autoRegister",
    "buttonText",
    "clientId",
    "clientSecret",
    "defaultStorageQuota",
    "enabled",
    "issuerUrl",
    "mobileOverrideEnabled",
    "mobileRedirectUri",
    "profileSigningAlgorithm",
    "roleClaim",
    "scope",
    "signingAlgorithm",
    "storageLabelClaim",
    "storageQuotaClaim",
    "timeout",
    "tokenEndpointAuthMethod"
  ],
  "title": "SystemConfigOAuthDto",
  "type": "object"
}

Config:

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

Fields:

auto_launch pydantic-field 

auto_launch: StrictBool

Auto launch

auto_register pydantic-field 

auto_register: StrictBool

Auto register

button_text pydantic-field 

button_text: StrictStr

Button text

client_id pydantic-field 

client_id: StrictStr

Client ID

client_secret pydantic-field 

client_secret: StrictStr

Client secret

default_storage_quota pydantic-field 

default_storage_quota: Optional[Annotated[int, Field(strict=True, ge=0)]]

Default storage quota

enabled pydantic-field 

enabled: StrictBool

Enabled

issuer_url pydantic-field 

issuer_url: StrictStr

Issuer URL

mobile_override_enabled pydantic-field 

mobile_override_enabled: StrictBool

Mobile override enabled

mobile_redirect_uri pydantic-field 

mobile_redirect_uri: StrictStr

Mobile redirect URI

profile_signing_algorithm pydantic-field 

profile_signing_algorithm: StrictStr

Profile signing algorithm

role_claim pydantic-field 

role_claim: StrictStr

Role claim

scope pydantic-field 

scope: StrictStr

Scope

storage_label_claim pydantic-field 

storage_label_claim: StrictStr

Storage label claim

storage_quota_claim pydantic-field 

storage_quota_claim: StrictStr

Storage quota claim

timeout pydantic-field 

timeout: Annotated[int, Field(strict=True, ge=1)]

Timeout

token_endpoint_auth_method pydantic-field 

token_endpoint_auth_method: OAuthTokenEndpointAuthMethod

Token endpoint auth method

from_dict classmethod 

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

Create an instance of SystemConfigOAuthDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "autoLaunch": obj.get("autoLaunch"),
            "autoRegister": obj.get("autoRegister"),
            "buttonText": obj.get("buttonText"),
            "clientId": obj.get("clientId"),
            "clientSecret": obj.get("clientSecret"),
            "defaultStorageQuota": obj.get("defaultStorageQuota"),
            "enabled": obj.get("enabled"),
            "issuerUrl": obj.get("issuerUrl"),
            "mobileOverrideEnabled": obj.get("mobileOverrideEnabled"),
            "mobileRedirectUri": obj.get("mobileRedirectUri"),
            "profileSigningAlgorithm": obj.get("profileSigningAlgorithm"),
            "roleClaim": obj.get("roleClaim"),
            "scope": obj.get("scope"),
            "signingAlgorithm": obj.get("signingAlgorithm"),
            "storageLabelClaim": obj.get("storageLabelClaim"),
            "storageQuotaClaim": obj.get("storageQuotaClaim"),
            "timeout": obj.get("timeout"),
            "tokenEndpointAuthMethod": obj.get("tokenEndpointAuthMethod"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of SystemConfigOAuthDto from a JSON string

Source code in immichpy/client/generated/models/system_config_o_auth_dto.py 
102
103
104
105
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SystemConfigOAuthDto 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/system_config_o_auth_dto.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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,
    )
    # set to None if default_storage_quota (nullable) is None
    # and model_fields_set contains the field
    if (
        self.default_storage_quota is None
        and "default_storage_quota" in self.model_fields_set
    ):
        _dict["defaultStorageQuota"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/system_config_o_auth_dto.py 
 97
 98
 99
100
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/system_config_o_auth_dto.py 
93
94
95
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))