Module `slack_sdk.scim.v1.user`

Classes

Expand source code

class User:
    active: Union[Optional[bool], DefaultArg]
    addresses: Union[Optional[List[UserAddress]], DefaultArg]
    display_name: Union[Optional[str], DefaultArg]
    emails: Union[Optional[List[TypeAndValue]], DefaultArg]
    external_id: Union[Optional[str], DefaultArg]
    groups: Union[Optional[List[UserGroup]], DefaultArg]
    id: Union[Optional[str], DefaultArg]
    meta: Union[Optional[UserMeta], DefaultArg]
    name: Union[Optional[UserName], DefaultArg]
    nick_name: Union[Optional[str], DefaultArg]
    phone_numbers: Union[Optional[List[TypeAndValue]], DefaultArg]
    photos: Union[Optional[List[UserPhoto]], DefaultArg]
    profile_url: Union[Optional[str], DefaultArg]
    roles: Union[Optional[List[TypeAndValue]], DefaultArg]
    schemas: Union[Optional[List[str]], DefaultArg]
    timezone: Union[Optional[str], DefaultArg]
    title: Union[Optional[str], DefaultArg]
    user_name: Union[Optional[str], DefaultArg]
    unknown_fields: Dict[str, Any]

    def __init__(
        self,
        *,
        active: Union[Optional[bool], DefaultArg] = NotGiven,
        addresses: Union[Optional[List[Union[UserAddress, Dict[str, Any]]]], DefaultArg] = NotGiven,
        display_name: Union[Optional[str], DefaultArg] = NotGiven,
        emails: Union[Optional[List[Union[TypeAndValue, Dict[str, Any]]]], DefaultArg] = NotGiven,
        external_id: Union[Optional[str], DefaultArg] = NotGiven,
        groups: Union[Optional[List[Union[UserGroup, Dict[str, Any]]]], DefaultArg] = NotGiven,
        id: Union[Optional[str], DefaultArg] = NotGiven,
        meta: Union[Optional[Union[UserMeta, Dict[str, Any]]], DefaultArg] = NotGiven,
        name: Union[Optional[Union[UserName, Dict[str, Any]]], DefaultArg] = NotGiven,
        nick_name: Union[Optional[str], DefaultArg] = NotGiven,
        phone_numbers: Union[Optional[List[Union[TypeAndValue, Dict[str, Any]]]], DefaultArg] = NotGiven,
        photos: Union[Optional[List[Union[UserPhoto, Dict[str, Any]]]], DefaultArg] = NotGiven,
        profile_url: Union[Optional[str], DefaultArg] = NotGiven,
        roles: Union[Optional[List[Union[TypeAndValue, Dict[str, Any]]]], DefaultArg] = NotGiven,
        schemas: Union[Optional[List[str]], DefaultArg] = NotGiven,
        timezone: Union[Optional[str], DefaultArg] = NotGiven,
        title: Union[Optional[str], DefaultArg] = NotGiven,
        user_name: Union[Optional[str], DefaultArg] = NotGiven,
        **kwargs,
    ) -> None:
        self.active = active
        self.addresses = (  # type: ignore
            [a if isinstance(a, UserAddress) else UserAddress(**a) for a in addresses]
            if _is_iterable(addresses)
            else addresses
        )
        self.display_name = display_name
        self.emails = (  # type: ignore
            [a if isinstance(a, TypeAndValue) else TypeAndValue(**a) for a in emails] if _is_iterable(emails) else emails
        )
        self.external_id = external_id
        self.groups = (  # type: ignore
            [a if isinstance(a, UserGroup) else UserGroup(**a) for a in groups] if _is_iterable(groups) else groups
        )
        self.id = id
        self.meta = UserMeta(**meta) if meta is not None and isinstance(meta, dict) else meta  # type: ignore
        self.name = UserName(**name) if name is not None and isinstance(name, dict) else name  # type: ignore
        self.nick_name = nick_name
        self.phone_numbers = (  # type: ignore
            [a if isinstance(a, TypeAndValue) else TypeAndValue(**a) for a in phone_numbers]
            if _is_iterable(phone_numbers)
            else phone_numbers
        )
        self.photos = (  # type: ignore
            [a if isinstance(a, UserPhoto) else UserPhoto(**a) for a in photos] if _is_iterable(photos) else photos
        )
        self.profile_url = profile_url
        self.roles = (  # type: ignore
            [a if isinstance(a, TypeAndValue) else TypeAndValue(**a) for a in roles] if _is_iterable(roles) else roles
        )
        self.schemas = schemas
        self.timezone = timezone
        self.title = title
        self.user_name = user_name

        self.unknown_fields = kwargs

    def to_dict(self):
        return _to_dict_without_not_given(self)

    def __repr__(self):
        return f"<slack_sdk.scim.{self.__class__.__name__}: {self.to_dict()}>"

Class variables

var active : bool | DefaultArg | None: The type of the None singleton.
var addresses : List[UserAddress] | DefaultArg | None: The type of the None singleton.
var display_name : str | DefaultArg | None: The type of the None singleton.
var emails : List[TypeAndValue] | DefaultArg | None: The type of the None singleton.
var external_id : str | DefaultArg | None: The type of the None singleton.
var groups : List[UserGroup] | DefaultArg | None: The type of the None singleton.
var id : str | DefaultArg | None: The type of the None singleton.
var meta : UserMeta | DefaultArg | None: The type of the None singleton.
var name : UserName | DefaultArg | None: The type of the None singleton.
var nick_name : str | DefaultArg | None: The type of the None singleton.
var phone_numbers : List[TypeAndValue] | DefaultArg | None: The type of the None singleton.
var photos : List[UserPhoto] | DefaultArg | None: The type of the None singleton.
var profile_url : str | DefaultArg | None: The type of the None singleton.
var roles : List[TypeAndValue] | DefaultArg | None: The type of the None singleton.
var schemas : List[str] | DefaultArg | None: The type of the None singleton.
var timezone : str | DefaultArg | None: The type of the None singleton.
var title : str | DefaultArg | None: The type of the None singleton.
var unknown_fields : Dict[str, Any]: The type of the None singleton.
var user_name : str | DefaultArg | None: The type of the None singleton.

Methods

def to_dict(self)

Expand source code

class UserAddress:
    country: Union[Optional[str], DefaultArg]
    locality: Union[Optional[str], DefaultArg]
    postal_code: Union[Optional[str], DefaultArg]
    primary: Union[Optional[bool], DefaultArg]
    region: Union[Optional[str], DefaultArg]
    street_address: Union[Optional[str], DefaultArg]
    unknown_fields: Dict[str, Any]

    def __init__(
        self,
        *,
        country: Union[Optional[str], DefaultArg] = NotGiven,
        locality: Union[Optional[str], DefaultArg] = NotGiven,
        postal_code: Union[Optional[str], DefaultArg] = NotGiven,
        primary: Union[Optional[bool], DefaultArg] = NotGiven,
        region: Union[Optional[str], DefaultArg] = NotGiven,
        street_address: Union[Optional[str], DefaultArg] = NotGiven,
        **kwargs,
    ) -> None:
        self.country = country
        self.locality = locality
        self.postal_code = postal_code
        self.primary = primary
        self.region = region
        self.street_address = street_address
        self.unknown_fields = kwargs

    def to_dict(self) -> dict:
        return _to_dict_without_not_given(self)

Class variables

var country : str | DefaultArg | None: The type of the None singleton.
var locality : str | DefaultArg | None: The type of the None singleton.
var postal_code : str | DefaultArg | None: The type of the None singleton.
var primary : bool | DefaultArg | None: The type of the None singleton.
var region : str | DefaultArg | None: The type of the None singleton.
var street_address : str | DefaultArg | None: The type of the None singleton.
var unknown_fields : Dict[str, Any]: The type of the None singleton.

Methods

def to_dict(self) ‑> dict

Expand source code

class UserEmail(TypeAndValue):
    pass

Ancestors

TypeAndValue

Inherited members

TypeAndValue:
- primary
- type
- unknown_fields
- value

class UserGroup (*, display: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, value: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, **kwargs)

Expand source code

class UserGroup:
    display: Union[Optional[str], DefaultArg]
    value: Union[Optional[str], DefaultArg]
    unknown_fields: Dict[str, Any]

    def __init__(
        self,
        *,
        display: Union[Optional[str], DefaultArg] = NotGiven,
        value: Union[Optional[str], DefaultArg] = NotGiven,
        **kwargs,
    ) -> None:
        self.display = display
        self.value = value
        self.unknown_fields = kwargs

    def to_dict(self) -> dict:
        return _to_dict_without_not_given(self)

Class variables

var display : str | DefaultArg | None: The type of the None singleton.
var unknown_fields : Dict[str, Any]: The type of the None singleton.
var value : str | DefaultArg | None: The type of the None singleton.

Methods

def to_dict(self) ‑> dict

class UserMeta (created: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, location: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, **kwargs)

Expand source code

class UserMeta:
    created: Union[Optional[str], DefaultArg]
    location: Union[Optional[str], DefaultArg]
    unknown_fields: Dict[str, Any]

    def __init__(
        self,
        created: Union[Optional[str], DefaultArg] = NotGiven,
        location: Union[Optional[str], DefaultArg] = NotGiven,
        **kwargs,
    ) -> None:
        self.created = created
        self.location = location
        self.unknown_fields = kwargs

    def to_dict(self) -> dict:
        return _to_dict_without_not_given(self)

Class variables

var created : str | DefaultArg | None: The type of the None singleton.
var location : str | DefaultArg | None: The type of the None singleton.
var unknown_fields : Dict[str, Any]: The type of the None singleton.

Methods

def to_dict(self) ‑> dict

class UserName (family_name: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, given_name: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, **kwargs)

Expand source code

class UserName:
    family_name: Union[Optional[str], DefaultArg]
    given_name: Union[Optional[str], DefaultArg]
    unknown_fields: Dict[str, Any]

    def __init__(
        self,
        family_name: Union[Optional[str], DefaultArg] = NotGiven,
        given_name: Union[Optional[str], DefaultArg] = NotGiven,
        **kwargs,
    ) -> None:
        self.family_name = family_name
        self.given_name = given_name
        self.unknown_fields = kwargs

    def to_dict(self) -> dict:
        return _to_dict_without_not_given(self)

Class variables

var family_name : str | DefaultArg | None: The type of the None singleton.
var given_name : str | DefaultArg | None: The type of the None singleton.
var unknown_fields : Dict[str, Any]: The type of the None singleton.

Methods

def to_dict(self) ‑> dict

Expand source code

class UserPhoneNumber(TypeAndValue):
    pass

Ancestors

TypeAndValue

Inherited members

TypeAndValue:
- primary
- type
- unknown_fields
- value

class UserPhoto (type: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, value: str | DefaultArg | None = <slack_sdk.scim.v1.default_arg.DefaultArg object>, **kwargs)

Expand source code

class UserPhoto:
    type: Union[Optional[str], DefaultArg]
    value: Union[Optional[str], DefaultArg]
    unknown_fields: Dict[str, Any]

    def __init__(
        self,
        type: Union[Optional[str], DefaultArg] = NotGiven,
        value: Union[Optional[str], DefaultArg] = NotGiven,
        **kwargs,
    ) -> None:
        self.type = type
        self.value = value
        self.unknown_fields = kwargs

    def to_dict(self) -> dict:
        return _to_dict_without_not_given(self)

Class variables

var type : str | DefaultArg | None: The type of the None singleton.
var unknown_fields : Dict[str, Any]: The type of the None singleton.
var value : str | DefaultArg | None: The type of the None singleton.

Methods

def to_dict(self) ‑> dict

Expand source code

class UserRole(TypeAndValue):
    pass

Ancestors

TypeAndValue

Inherited members

TypeAndValue:
- primary
- type
- unknown_fields
- value