Module: auth_types_response

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations
from typing import List
from pydantic import BaseModel
from cl.runtime.routers.user_request import UserRequest


class AuthTypesResponseItem(BaseModel):
    """Response data type for the /auth/types route."""

    id: str
    """Identifier for the authentication type."""

    name: str
    """Name of the authentication type."""

    type: str
    """Type of the authentication."""

    @classmethod
    def get_types(cls, request: UserRequest) -> List[AuthTypesResponseItem]:
        """Implements /auth/types route."""

        # Do not perform authentication in the open source version
        return []

Classes

class AuthTypesResponseItem (**data: Any)

Response data type for the /auth/types route.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class AuthTypesResponseItem(BaseModel):
    """Response data type for the /auth/types route."""

    id: str
    """Identifier for the authentication type."""

    name: str
    """Name of the authentication type."""

    type: str
    """Type of the authentication."""

    @classmethod
    def get_types(cls, request: UserRequest) -> List[AuthTypesResponseItem]:
        """Implements /auth/types route."""

        # Do not perform authentication in the open source version
        return []

Ancestors

pydantic.main.BaseModel

Class variables

var id: Identifier for the authentication type.
var model_computed_fields
var model_config
var model_fields
var name: Name of the authentication type.
var type: Type of the authentication.

Static methods

def get_types(request: UserRequest) -> List[AuthTypesResponseItem]: Implements /auth/types route.