sym.sdk.user.User

class sym.sdk.user.User

Bases: sym.sdk.resource.SymBaseResource

The atomic representation of a user in Sym.

UserIdentity, which are used for referencing said user in external systems.

Methods

dict()

Represent this resource as a dictionary.

identity(service_type[, service_id])

Retrieves this User's UserIdentity for a particular external system.

Attributes

email

The User's email if the user is of type "normal", or None otherwise.

first_name

The User's first name.

identities

Retrieves the set of identities associated with this User, grouped by service type.

last_name

The User's last name.

type

The User's type (i.e.

username

The User's username if the user is of type "bot", or the email if the user is of type "normal".

dict()

Represent this resource as a dictionary.

property email

The User’s email if the user is of type “normal”, or None otherwise.

property first_name

The User’s first name.

property identities

Retrieves the set of identities associated with this User, grouped by service type.

A mapping of service types to lists of UserIdentity.

identity(service_type: str, service_id: Optional[str] = None) Optional[sym.sdk.user.UserIdentity]

Retrieves this User’s UserIdentity for a particular external system.

External systems specified by a service_type, and optionally a service_id.

Parameters
  • service_type – The name of one of Sym’s integrations.

  • service_id – An identifier for an instance of a service, such as a Slack Workspace ID.

Returns

A UserIdentity, or None if no identity is found for the Integration.

property last_name

The User’s last name.

property type

The User’s type (i.e. “bot” or “normal”).

property username

The User’s username if the user is of type “bot”, or the email if the user is of type “normal”.