sym.sdk.user

Representations of Users in both Sym and third parties.

Classes

User

The atomic representation of a user in Sym.

UserIdentity

Represents a User’s identity in an external system such as Slack or PagerDuty.

class sym.sdk.user.User

The atomic representation of a user in Sym.

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

property email

The User’s email.

property first_name

The User’s first name.

identity(integration_name: Optional[str] = None, integration_srn: Optional[sym.sdk.resource.SRN] = None)Optional[sym.sdk.user.UserIdentity]

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

External systems specified by either integration_name or integration_srn.

Parameters
Returns

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

property last_name

The User’s last name.

property username

The User’s Sym username.

class sym.sdk.user.UserIdentity

Represents a User’s identity in an external system such as Slack or PagerDuty.

property service

The name of the external system providing the identity.

For example, slack.

property user_id

The User’s identifier in the external system.

For example, the User’s Slack ID.