| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
Wire.API.User
Synopsis
- data ListUsersById = ListUsersById {}
- newtype UserIdList = UserIdList {}
- newtype UserIds = UserIds {}
- newtype QualifiedUserIdList = QualifiedUserIdList {}
- qualifiedUserIdListObjectSchema :: ObjectSchema SwaggerDoc QualifiedUserIdList
- newtype LimitedQualifiedUserIdList (max :: Nat) = LimitedQualifiedUserIdList {
- qualifiedUsers :: Range 1 max [Qualified UserId]
- data ScimUserInfo = ScimUserInfo {}
- newtype ScimUserInfos = ScimUserInfos {}
- newtype UserSet = UserSet {}
- data UserProfile = UserProfile {
- profileQualifiedId :: Qualified UserId
- profileName :: Name
- profileTextStatus :: Maybe TextStatus
- profilePict :: Pict
- profileAssets :: [Asset]
- profileAccentId :: ColourId
- profileDeleted :: Bool
- profileService :: Maybe ServiceRef
- profileHandle :: Maybe Handle
- profileExpire :: Maybe UTCTimeMillis
- profileTeam :: Maybe TeamId
- profileEmail :: Maybe EmailAddress
- profileLegalholdStatus :: UserLegalHoldStatus
- profileSupportedProtocols :: Set BaseProtocolTag
- newtype SelfProfile = SelfProfile {}
- data User = User {
- userQualifiedId :: Qualified UserId
- userIdentity :: Maybe UserIdentity
- userDisplayName :: Name
- userTextStatus :: Maybe TextStatus
- userPict :: Pict
- userAssets :: [Asset]
- userAccentId :: ColourId
- userDeleted :: Bool
- userLocale :: Locale
- userService :: Maybe ServiceRef
- userHandle :: Maybe Handle
- userExpire :: Maybe UTCTimeMillis
- userTeam :: Maybe TeamId
- userManagedBy :: ManagedBy
- userSupportedProtocols :: Set BaseProtocolTag
- userId :: User -> UserId
- userEmail :: User -> Maybe EmailAddress
- userSSOId :: User -> Maybe UserSSOId
- userIssuer :: User -> Maybe Issuer
- userSCIMExternalId :: User -> Maybe Text
- scimExternalId :: ManagedBy -> UserSSOId -> Maybe Text
- ssoIssuerAndNameId :: UserSSOId -> Maybe (Text, Text)
- mkUserProfile :: EmailVisibilityConfigWithViewer -> User -> UserLegalHoldStatus -> UserProfile
- mkUserProfileWithEmail :: Maybe EmailAddress -> User -> UserLegalHoldStatus -> UserProfile
- userObjectSchema :: ObjectSchema SwaggerDoc User
- data CreateUserTeam = CreateUserTeam {
- createdTeamId :: !TeamId
- createdTeamName :: !Text
- type UpgradePersonalToTeamResponses = '[ErrorResponse UserAlreadyInATeam, ErrorResponse UserNotFound, Respond 200 "Team created" CreateUserTeam]
- data UpgradePersonalToTeamError
- newtype NewUserPublic = NewUserPublic NewUser
- data RegisterError
- = RegisterErrorAllowlistError
- | RegisterErrorInvalidInvitationCode
- | RegisterErrorMissingIdentity
- | RegisterErrorUserKeyExists
- | RegisterErrorInvalidActivationCodeWrongUser
- | RegisterErrorInvalidActivationCodeWrongCode
- | RegisterErrorInvalidEmail
- | RegisterErrorInvalidPhone
- | RegisterErrorBlacklistedEmail
- | RegisterErrorTooManyTeamMembers
- | RegisterErrorUserCreationRestricted
- data RegisterSuccess = RegisterSuccess SetCookie SelfProfile
- type RegisterResponses = RegisterErrorResponses .++ '[WithHeaders '[DescHeader "Set-Cookie" "Cookie" SetCookie, DescHeader "Location" "UserId" UserId] RegisterSuccess (Respond 201 "User created and pending activation" SelfProfile)]
- type RegisterInternalResponses = RegisterErrorResponses .++ '[WithHeaders '[DescHeader "Location" "UserId" UserId] SelfProfile (Respond 201 "User created and pending activation" SelfProfile)]
- data NewUser = NewUser {
- newUserDisplayName :: Name
- newUserUUID :: Maybe UUID
- newUserIdentity :: Maybe UserIdentity
- newUserPict :: Maybe Pict
- newUserAssets :: [Asset]
- newUserAccentId :: Maybe ColourId
- newUserEmailCode :: Maybe ActivationCode
- newUserOrigin :: Maybe NewUserOrigin
- newUserLabel :: Maybe CookieLabel
- newUserLocale :: Maybe Locale
- newUserPassword :: Maybe PlainTextPassword8
- newUserExpiresIn :: Maybe ExpiresIn
- newUserManagedBy :: Maybe ManagedBy
- newUserSupportedProtocols :: Maybe (Set BaseProtocolTag)
- emptyNewUser :: Name -> NewUser
- data NewUserSpar = NewUserSpar {}
- data CreateUserSparError
- type CreateUserSparInternalResponses = CreateUserSparErrorResponses .++ '[WithHeaders '[DescHeader "Location" "UserId" UserId] SelfProfile (Respond 201 "User created and pending activation" SelfProfile)]
- newUserFromSpar :: NewUserSpar -> NewUser
- urefToExternalId :: UserRef -> Maybe Text
- type ExpiresIn = Range 1 604800 Integer
- newUserTeam :: NewUser -> Maybe NewTeamUser
- newUserEmail :: NewUser -> Maybe EmailAddress
- newUserSSOId :: NewUser -> Maybe UserSSOId
- isNewUserEphemeral :: NewUser -> Bool
- isNewUserTeamMember :: NewUser -> Bool
- data NewUserOrigin
- newtype InvitationCode = InvitationCode {}
- data NewTeamUser
- data BindingNewTeamUser = BindingNewTeamUser {}
- data UserUpdate = UserUpdate {
- uupName :: Maybe Name
- uupTextStatus :: Maybe TextStatus
- uupPict :: Maybe Pict
- uupAssets :: Maybe [Asset]
- uupAccentId :: Maybe ColourId
- data UpdateProfileError
- type PutSelfResponses = PutSelfErrorResponses .++ '[RespondEmpty 200 "User updated"]
- data PasswordChange = PasswordChange {}
- data ChangePasswordError
- type ChangePasswordResponses = ChangePasswordErrorResponses .++ '[RespondEmpty 200 "Password Changed"]
- newtype LocaleUpdate = LocaleUpdate {}
- newtype EmailUpdate = EmailUpdate {}
- newtype PhoneUpdate = PhoneUpdate {}
- data ChangePhoneError
- type ChangePhoneResponses = ChangePhoneErrorResponses .++ '[RespondEmpty 202 "Phone updated"]
- data RemoveIdentityError
- type RemoveIdentityResponses = RemoveIdentityErrorResponses .++ '[RespondEmpty 200 "Identity Removed"]
- newtype HandleUpdate = HandleUpdate {}
- data ChangeHandleError
- type ChangeHandleResponses = ChangeHandleErrorResponses .++ '[RespondEmpty 200 "Handle Changed"]
- newtype NameUpdate = NameUpdate {}
- data ChangeEmailResponse
- newtype DeleteUser = DeleteUser {}
- mkDeleteUser :: Maybe PlainTextPassword6 -> DeleteUser
- data VerifyDeleteUser = VerifyDeleteUser {}
- newtype DeletionCodeTimeout = DeletionCodeTimeout {}
- data DeleteUserResponse
- data DeleteUserResult
- data AccountStatus
- newtype AccountStatusUpdate = AccountStatusUpdate {}
- data AccountStatusResp = AccountStatusResp {}
- data UserAccount = UserAccount {}
- data ExtendedUserAccount = ExtendedUserAccount {}
- data NewUserScimInvitation = NewUserScimInvitation {}
- data ListUsersQuery
- = ListUsersByIds [Qualified UserId]
- | ListUsersByHandles (Range 1 4 [Qualified Handle])
- newtype GetActivationCodeResp = GetActivationCodeResp {}
- newtype GetPasswordResetCodeResp = GetPasswordResetCodeResp {}
- data CheckBlacklistResponse
- newtype ManagedByUpdate = ManagedByUpdate {}
- newtype RichInfoUpdate = RichInfoUpdate {}
- type PasswordResetPair = (PasswordResetKey, PasswordResetCode)
- data UpdateSSOIdResponse
- data CheckHandleResponse
- data UpdateConnectionsInternal
- data EmailVisibility a
- type EmailVisibilityConfig = EmailVisibility ()
- type EmailVisibilityConfigWithViewer = EmailVisibility (Maybe (TeamId, TeamMember))
- module Wire.API.Locale
- data EmailAddress
- newtype Phone = Phone {}
- data UserIdentity
- data UserSSOId
- unsafeEmailAddress :: ByteString -> ByteString -> EmailAddress
- localPart :: EmailAddress -> ByteString
- domainPart :: EmailAddress -> ByteString
- addrSpec :: Parser EmailAddress
- emailAddress :: ByteString -> Maybe EmailAddress
- fromEmail :: EmailAddress -> Text
- emailAddressText :: Text -> Maybe EmailAddress
- emailToSAMLNameID :: EmailAddress -> Either String NameID
- emailFromSAML :: Email -> EmailAddress
- isSSOIdentity :: UserIdentity -> Bool
- newIdentity :: Maybe EmailAddress -> Maybe UserSSOId -> Maybe UserIdentity
- emailIdentity :: UserIdentity -> Maybe EmailAddress
- ssoIdentity :: UserIdentity -> Maybe UserSSOId
- userIdentityObjectSchema :: ObjectSchema SwaggerDoc UserIdentity
- maybeUserIdentityObjectSchema :: ObjectSchema SwaggerDoc (Maybe UserIdentity)
- maybeUserIdentityFromComponents :: UserIdentityComponents -> Maybe UserIdentity
- parsePhone :: Text -> Maybe Phone
- isValidPhone :: Text -> Bool
- mkSampleUref :: Text -> Text -> UserRef
- mkSimpleSampleUref :: UserRef
- module Wire.API.User.Profile
- data VerificationAction
- data SendVerificationCode = SendVerificationCode {}
- data BaseProtocolTag
- baseProtocolToProtocol :: BaseProtocolTag -> ProtocolTag
- newtype SupportedProtocolUpdate = SupportedProtocolUpdate {}
- defSupportedProtocols :: Set BaseProtocolTag
- protocolSetBits :: Set BaseProtocolTag -> Word32
- protocolSetFromBits :: Word32 -> Set BaseProtocolTag
Documentation
data ListUsersById Source #
Constructors
| ListUsersById | |
Fields | |
Instances
newtype UserIdList Source #
This datatype replaces the old Members datatype,
which has been replaced by SimpleMembers. This is
needed due to backwards compatible reasons since old
clients will break if we switch these types. Also, this
definition represents better what information it carries
Constructors
| UserIdList | |
Instances
Response type for endpoints returning lists of users with a specific connection state.
E.g. getContactList returns a UserIds containing the list of connections in an
Accepted state.
There really shouldn't be both types UserIds and UserIdList, but refactoring them
away requires changing the api.
Instances
| Arbitrary UserIds Source # | |
| FromJSON UserIds Source # | |
| ToJSON UserIds Source # | |
| Generic UserIds Source # | |
| Show UserIds Source # | |
| Eq UserIds Source # | |
| ToSchema UserIds Source # | |
Defined in Wire.API.User Methods declareNamedSchema :: Proxy UserIds -> Declare (Definitions Schema) NamedSchema Source # | |
| ToSchema UserIds Source # | |
Defined in Wire.API.User Methods | |
| type Rep UserIds Source # | |
Defined in Wire.API.User | |
newtype QualifiedUserIdList Source #
Constructors
| QualifiedUserIdList | |
Fields | |
Instances
newtype LimitedQualifiedUserIdList (max :: Nat) Source #
We cannot use Wrapped here because all the instances require proof that 1
is less than or equal to max.
Constructors
| LimitedQualifiedUserIdList | |
Fields
| |
Instances
data ScimUserInfo Source #
Constructors
| ScimUserInfo | |
Fields | |
Instances
newtype ScimUserInfos Source #
Constructors
| ScimUserInfos | |
Fields | |
Instances
Set of user ids, can be used for different purposes (e.g., used on the internal APIs for listing user's clients)
Instances
| Arbitrary UserSet Source # | |
| FromJSON UserSet Source # | |
| ToJSON UserSet Source # | |
| Generic UserSet Source # | |
| Show UserSet Source # | |
| Eq UserSet Source # | |
| ToSchema UserSet Source # | |
Defined in Wire.API.User Methods declareNamedSchema :: Proxy UserSet -> Declare (Definitions Schema) NamedSchema Source # | |
| ToSchema UserSet Source # | |
Defined in Wire.API.User Methods | |
| type Rep UserSet Source # | |
Defined in Wire.API.User | |
data UserProfile Source #
A subset of the data of an existing User that is returned on the API and is visible to
other users. Each user also has access to their own profile in a richer format --
SelfProfile.
Constructors
| UserProfile | |
Fields
| |
Instances
newtype SelfProfile Source #
A self profile.
Constructors
| SelfProfile | |
Instances
The data of an existing user.
Constructors
| User | |
Fields
| |
Instances
mkUserProfile :: EmailVisibilityConfigWithViewer -> User -> UserLegalHoldStatus -> UserProfile Source #
UpgradePersonalToTeam
data CreateUserTeam Source #
Constructors
| CreateUserTeam | |
Fields
| |
Instances
type UpgradePersonalToTeamResponses = '[ErrorResponse UserAlreadyInATeam, ErrorResponse UserNotFound, Respond 200 "Team created" CreateUserTeam] Source #
data UpgradePersonalToTeamError Source #
Instances
NewUser
newtype NewUserPublic Source #
We use the same NewUser type for the /register and /i/users endpoints. This
newtype is used as request body type for the public /register endpoint, where only a
subset of the NewUser functionality should be allowed.
Specifically, we forbid the following:
- Setting
SSOIdentity(SSO users are created by Spar) - Setting the UUID (only needed so that Spar can find the user if Spar crashes before it finishes creating the user).
- Setting
ManagedBy(it should be the default in all cases unless Spar creates a SCIM-managed user)
Constructors
| NewUserPublic NewUser |
Instances
data RegisterError Source #
Constructors
Instances
data RegisterSuccess Source #
Constructors
| RegisterSuccess SetCookie SelfProfile |
Instances
| res ~ CreateUserSparResponses => AsUnion res (Either CreateUserSparError RegisterSuccess) Source # | |
Defined in Wire.API.User Methods toUnion :: Either CreateUserSparError RegisterSuccess -> Union (ResponseTypes res) Source # fromUnion :: Union (ResponseTypes res) -> Either CreateUserSparError RegisterSuccess Source # | |
| res ~ RegisterResponses => AsUnion res (Either RegisterError RegisterSuccess) Source # | |
Defined in Wire.API.User Methods toUnion :: Either RegisterError RegisterSuccess -> Union (ResponseTypes res) Source # fromUnion :: Union (ResponseTypes res) -> Either RegisterError RegisterSuccess Source # | |
| AsHeaders '[SetCookie, UserId] SelfProfile RegisterSuccess Source # | |
Defined in Wire.API.User Methods fromHeaders :: (NP I '[SetCookie, UserId], SelfProfile) -> RegisterSuccess Source # toHeaders :: RegisterSuccess -> (NP I '[SetCookie, UserId], SelfProfile) Source # | |
type RegisterResponses = RegisterErrorResponses .++ '[WithHeaders '[DescHeader "Set-Cookie" "Cookie" SetCookie, DescHeader "Location" "UserId" UserId] RegisterSuccess (Respond 201 "User created and pending activation" SelfProfile)] Source #
type RegisterInternalResponses = RegisterErrorResponses .++ '[WithHeaders '[DescHeader "Location" "UserId" UserId] SelfProfile (Respond 201 "User created and pending activation" SelfProfile)] Source #
Constructors
| NewUser | |
Fields
| |
Instances
emptyNewUser :: Name -> NewUser Source #
data NewUserSpar Source #
Constructors
| NewUserSpar | |
Instances
data CreateUserSparError Source #
Constructors
| CreateUserSparHandleError ChangeHandleError | |
| CreateUserSparRegistrationError RegisterError |
Instances
type CreateUserSparInternalResponses = CreateUserSparErrorResponses .++ '[WithHeaders '[DescHeader "Location" "UserId" UserId] SelfProfile (Respond 201 "User created and pending activation" SelfProfile)] Source #
newUserFromSpar :: NewUserSpar -> NewUser Source #
newUserTeam :: NewUser -> Maybe NewTeamUser Source #
newUserEmail :: NewUser -> Maybe EmailAddress Source #
isNewUserEphemeral :: NewUser -> Bool Source #
A user is Ephemeral if she has neither email, phone, nor sso credentials and is not created via scim. Ephemeral users can be deleted after expires_in or sessionTokenTimeout (whichever comes earlier).
isNewUserTeamMember :: NewUser -> Bool Source #
NewUserOrigin
data NewUserOrigin Source #
Instances
newtype InvitationCode Source #
A random invitation code for use during registration
Constructors
| InvitationCode | |
Fields | |
Instances
data NewTeamUser Source #
Constructors
| NewTeamMember InvitationCode | requires email address |
| NewTeamCreator BindingNewTeamUser | |
| NewTeamMemberSSO TeamId | sso: users with saml credentials and/or created via scim |
Instances
data BindingNewTeamUser Source #
Constructors
| BindingNewTeamUser | |
Fields | |
Instances
Profile Updates
data UserUpdate Source #
Constructors
| UserUpdate | |
Fields
| |
Instances
data UpdateProfileError Source #
Constructors
| DisplayNameManagedByScim | |
| ProfileNotFound |
Instances
| Generic UpdateProfileError Source # | |
Defined in Wire.API.User Associated Types type Rep UpdateProfileError :: Type -> Type # Methods from :: UpdateProfileError -> Rep UpdateProfileError x # to :: Rep UpdateProfileError x -> UpdateProfileError # | |
| Generic UpdateProfileError Source # | |
Defined in Wire.API.User Associated Types type Code UpdateProfileError :: [[Type]] Source # Methods from :: UpdateProfileError -> Rep UpdateProfileError Source # | |
| res ~ PutSelfResponses => AsUnion res (Maybe UpdateProfileError) Source # | |
Defined in Wire.API.User Methods toUnion :: Maybe UpdateProfileError -> Union (ResponseTypes res) Source # fromUnion :: Union (ResponseTypes res) -> Maybe UpdateProfileError Source # | |
| type Rep UpdateProfileError Source # | |
Defined in Wire.API.User | |
| type Code UpdateProfileError Source # | |
Defined in Wire.API.User | |
type PutSelfResponses = PutSelfErrorResponses .++ '[RespondEmpty 200 "User updated"] Source #
data PasswordChange Source #
The payload for setting or changing a password.
Constructors
| PasswordChange | |
Instances
data ChangePasswordError Source #
Instances
type ChangePasswordResponses = ChangePasswordErrorResponses .++ '[RespondEmpty 200 "Password Changed"] Source #
newtype LocaleUpdate Source #
Constructors
| LocaleUpdate | |
Instances
newtype EmailUpdate Source #
Constructors
| EmailUpdate | |
Fields | |
Instances
newtype PhoneUpdate Source #
Constructors
| PhoneUpdate | |
Instances
data ChangePhoneError Source #
Constructors
| PhoneExists | |
| InvalidNewPhone |
Instances
| Generic ChangePhoneError Source # | |
Defined in Wire.API.User Associated Types type Rep ChangePhoneError :: Type -> Type # Methods from :: ChangePhoneError -> Rep ChangePhoneError x # to :: Rep ChangePhoneError x -> ChangePhoneError # | |
| Generic ChangePhoneError Source # | |
Defined in Wire.API.User Associated Types type Code ChangePhoneError :: [[Type]] Source # Methods from :: ChangePhoneError -> Rep ChangePhoneError Source # to :: Rep ChangePhoneError -> ChangePhoneError Source # | |
| res ~ ChangePhoneResponses => AsUnion res (Maybe ChangePhoneError) Source # | |
Defined in Wire.API.User Methods toUnion :: Maybe ChangePhoneError -> Union (ResponseTypes res) Source # fromUnion :: Union (ResponseTypes res) -> Maybe ChangePhoneError Source # | |
| type Rep ChangePhoneError Source # | |
| type Code ChangePhoneError Source # | |
Defined in Wire.API.User | |
type ChangePhoneResponses = ChangePhoneErrorResponses .++ '[RespondEmpty 202 "Phone updated"] Source #
data RemoveIdentityError Source #
Constructors
| LastIdentity | |
| NoPassword | |
| NoIdentity |
Instances
type RemoveIdentityResponses = RemoveIdentityErrorResponses .++ '[RespondEmpty 200 "Identity Removed"] Source #
newtype HandleUpdate Source #
Constructors
| HandleUpdate | |
Instances
data ChangeHandleError Source #
Instances
type ChangeHandleResponses = ChangeHandleErrorResponses .++ '[RespondEmpty 200 "Handle Changed"] Source #
newtype NameUpdate Source #
Constructors
| NameUpdate | |
Instances
data ChangeEmailResponse Source #
Instances
| AsUnion '[Respond 202 "Update accepted and pending activation of the new email" (), Respond 204 "No update, current and new email address are the same" ()] ChangeEmailResponse Source # | |
Defined in Wire.API.User Methods toUnion :: ChangeEmailResponse -> Union (ResponseTypes '[Respond 202 "Update accepted and pending activation of the new email" (), Respond 204 "No update, current and new email address are the same" ()]) Source # fromUnion :: Union (ResponseTypes '[Respond 202 "Update accepted and pending activation of the new email" (), Respond 204 "No update, current and new email address are the same" ()]) -> ChangeEmailResponse Source # | |
Account Deletion
newtype DeleteUser Source #
Payload for requesting account deletion.
Constructors
| DeleteUser | |
Fields | |
Instances
data VerifyDeleteUser Source #
Payload for verifying account deletion via a code.
Constructors
| VerifyDeleteUser | |
Fields | |
Instances
newtype DeletionCodeTimeout Source #
A response for a pending deletion code.
Constructors
| DeletionCodeTimeout | |
Fields | |
Instances
data DeleteUserResponse Source #
Like DeleteUserResult, but without the exception case.
Instances
| AsUnion '[Respond 200 "UserResponseAccountAlreadyDeleted" (), Respond 202 "UserResponseAccountDeleted" ()] DeleteUserResponse Source # | |
Defined in Wire.API.User Methods toUnion :: DeleteUserResponse -> Union (ResponseTypes '[Respond 200 "UserResponseAccountAlreadyDeleted" (), Respond 202 "UserResponseAccountDeleted" ()]) Source # fromUnion :: Union (ResponseTypes '[Respond 200 "UserResponseAccountAlreadyDeleted" (), Respond 202 "UserResponseAccountDeleted" ()]) -> DeleteUserResponse Source # | |
data DeleteUserResult Source #
Result of an internal user/account deletion
Constructors
| NoUser | User never existed |
| AccountAlreadyDeleted | User/account was deleted before |
| AccountDeleted | User/account was deleted in this call |
Instances
| Show DeleteUserResult Source # | |
Defined in Wire.API.User Methods showsPrec :: Int -> DeleteUserResult -> ShowS # show :: DeleteUserResult -> String # showList :: [DeleteUserResult] -> ShowS # | |
| Eq DeleteUserResult Source # | |
Defined in Wire.API.User Methods (==) :: DeleteUserResult -> DeleteUserResult -> Bool # (/=) :: DeleteUserResult -> DeleteUserResult -> Bool # | |
Account Status
data AccountStatus Source #
Constructors
| Active | |
| Suspended | |
| Deleted | |
| Ephemeral | |
| PendingInvitation | for most intents & purposes, this is another form of inactive. it is used for allowing scim to find users that have not accepted their invitation yet after creating via scim. |
Instances
newtype AccountStatusUpdate Source #
Constructors
| AccountStatusUpdate | |
Fields | |
Instances
data AccountStatusResp Source #
Constructors
| AccountStatusResp | |
Fields | |
Instances
Account
data UserAccount Source #
A UserAccount is targeted to be used by our "backoffice" and represents all the data related to a user in our system, regardless of whether they are active or not, their status, etc.
Constructors
| UserAccount | |
Fields
| |
Instances
data ExtendedUserAccount Source #
This can be parsed as UserAccount, but it has an extra field email_unvalidated from
brig's cassandra that is needed in spar. so we return this from GET iusers in brig.
Constructors
| ExtendedUserAccount | |
Fields | |
Instances
Scim invitations
data NewUserScimInvitation Source #
Constructors
| NewUserScimInvitation | |
Instances
List Users
data ListUsersQuery Source #
Constructors
| ListUsersByIds [Qualified UserId] | |
| ListUsersByHandles (Range 1 4 [Qualified Handle]) |
Instances
| FromJSON ListUsersQuery Source # | |
Defined in Wire.API.User Methods parseJSON :: Value -> Parser ListUsersQuery Source # parseJSONList :: Value -> Parser [ListUsersQuery] Source # | |
| ToJSON ListUsersQuery Source # | |
Defined in Wire.API.User Methods toJSON :: ListUsersQuery -> Value Source # toEncoding :: ListUsersQuery -> Encoding Source # toJSONList :: [ListUsersQuery] -> Value Source # toEncodingList :: [ListUsersQuery] -> Encoding Source # | |
| Show ListUsersQuery Source # | |
Defined in Wire.API.User Methods showsPrec :: Int -> ListUsersQuery -> ShowS # show :: ListUsersQuery -> String # showList :: [ListUsersQuery] -> ShowS # | |
| Eq ListUsersQuery Source # | |
Defined in Wire.API.User Methods (==) :: ListUsersQuery -> ListUsersQuery -> Bool # (/=) :: ListUsersQuery -> ListUsersQuery -> Bool # | |
| ToSchema ListUsersQuery Source # | |
Defined in Wire.API.User Methods declareNamedSchema :: Proxy ListUsersQuery -> Declare (Definitions Schema) NamedSchema Source # | |
misc internal
newtype GetActivationCodeResp Source #
Constructors
| GetActivationCodeResp | |
Fields | |
Instances
newtype GetPasswordResetCodeResp Source #
Constructors
| GetPasswordResetCodeResp | |
Instances
data CheckBlacklistResponse Source #
Constructors
| NotBlacklisted | |
| YesBlacklisted |
Instances
| AsUnion '[Respond 404 "Not blacklisted" (), Respond 200 "Yes blacklisted" ()] CheckBlacklistResponse Source # | |
Defined in Wire.API.User Methods toUnion :: CheckBlacklistResponse -> Union (ResponseTypes '[Respond 404 "Not blacklisted" (), Respond 200 "Yes blacklisted" ()]) Source # fromUnion :: Union (ResponseTypes '[Respond 404 "Not blacklisted" (), Respond 200 "Yes blacklisted" ()]) -> CheckBlacklistResponse Source # | |
newtype ManagedByUpdate Source #
Constructors
| ManagedByUpdate | |
Fields | |
Instances
newtype RichInfoUpdate Source #
Constructors
| RichInfoUpdate | |
Fields | |
Instances
data UpdateSSOIdResponse Source #
Constructors
| UpdateSSOIdSuccess | |
| UpdateSSOIdNotFound |
Instances
| AsUnion '[RespondEmpty 200 "UpdateSSOIdSuccess", RespondEmpty 404 "UpdateSSOIdNotFound"] UpdateSSOIdResponse Source # | |
Defined in Wire.API.User Methods toUnion :: UpdateSSOIdResponse -> Union (ResponseTypes '[RespondEmpty 200 "UpdateSSOIdSuccess", RespondEmpty 404 "UpdateSSOIdNotFound"]) Source # fromUnion :: Union (ResponseTypes '[RespondEmpty 200 "UpdateSSOIdSuccess", RespondEmpty 404 "UpdateSSOIdNotFound"]) -> UpdateSSOIdResponse Source # | |
data CheckHandleResponse Source #
Constructors
| CheckHandleResponseFound | |
| CheckHandleResponseNotFound |
Instances
| AsUnion '[RespondEmpty 200 "CheckHandleResponseFound", RespondEmpty 404 "CheckHandleResponseNotFound"] CheckHandleResponse Source # | |
Defined in Wire.API.User Methods toUnion :: CheckHandleResponse -> Union (ResponseTypes '[RespondEmpty 200 "CheckHandleResponseFound", RespondEmpty 404 "CheckHandleResponseNotFound"]) Source # fromUnion :: Union (ResponseTypes '[RespondEmpty 200 "CheckHandleResponseFound", RespondEmpty 404 "CheckHandleResponseNotFound"]) -> CheckHandleResponse Source # | |
data UpdateConnectionsInternal Source #
FUTUREWORK: This needs to get Qualified IDs when implementing Legalhold + Federation, as it's used in the internal putConnectionInternal galley->Brig "iusersconnections-status" endpoint. Internal RPCs need to be updated accordingly. See https://wearezeta.atlassian.net/browse/SQCORE-973
Constructors
| BlockForMissingLHConsent UserId [UserId] | |
| RemoveLHBlocksInvolving UserId | |
| CreateConnectionForTest UserId (Qualified UserId) | This must only be used by tests |
Instances
data EmailVisibility a Source #
Configurations for whether to show a user's email to others.
Constructors
| EmailVisibleIfOnTeam | Anyone can see the email of someone who is on ANY team. This may sound strange; but certain on-premise hosters have many different teams and still want them to see each-other's emails. |
| EmailVisibleIfOnSameTeam a | Anyone on your team with at least |
| EmailVisibleToSelf | Show your email only to yourself |
Instances
type EmailVisibilityConfig = EmailVisibility () Source #
re-exports
module Wire.API.Locale
data EmailAddress Source #
Represents an email address.
Instances
Instances
| Arbitrary Phone Source # | |
| FromJSON Phone Source # | |
| ToJSON Phone Source # | |
| Generic Phone Source # | |
| Show Phone Source # | |
| FromByteString Phone Source # | |
Defined in Wire.API.User.Phone | |
| ToByteString Phone Source # | |
| Cql Phone Source # | |
| Eq Phone Source # | |
| Ord Phone Source # | |
| FromHttpApiData Phone Source # | |
Defined in Wire.API.User.Phone | |
| ToHttpApiData Phone Source # | |
Defined in Wire.API.User.Phone Methods toUrlPiece :: Phone -> Text Source # toEncodedUrlPiece :: Phone -> Builder Source # toHeader :: Phone -> ByteString Source # toQueryParam :: Phone -> Text Source # toEncodedQueryParam :: Phone -> Builder Source # | |
| ToParamSchema Phone Source # | |
Defined in Wire.API.User.Phone | |
| ToSchema Phone Source # | |
Defined in Wire.API.User.Phone Methods declareNamedSchema :: Proxy Phone -> Declare (Definitions Schema) NamedSchema Source # | |
| ToSchema Phone Source # | |
Defined in Wire.API.User.Phone Methods | |
| type Rep Phone Source # | |
Defined in Wire.API.User.Phone | |
data UserIdentity Source #
The private unique user identity that is used for login and account recovery.
Constructors
| EmailIdentity EmailAddress | |
| SSOIdentity UserSSOId (Maybe EmailAddress) |
Instances
User's external identity.
NB: this type is serialized to the full xml encoding of the UserRef components, but
deserialiation is more lenient: it also allows for the Issuer to be a plain URL (without
xml around it), and the NameID to be an email address (=> format "email") or an arbitrary
text (=> format "unspecified"). This is for backwards compatibility and general
robustness.
FUTUREWORK: we should probably drop this entirely and store saml and scim data in separate database columns.
Constructors
| UserSSOId UserRef | |
| UserScimExternalId Text |
Instances
unsafeEmailAddress :: ByteString -> ByteString -> EmailAddress Source #
Creates an email address without validating it. You should only use this when reading data from somewhere it has already been validated (e.g. a database).
localPart :: EmailAddress -> ByteString Source #
Extracts the local part of an email address.
domainPart :: EmailAddress -> ByteString Source #
Extracts the domain part of an email address.
addrSpec :: Parser EmailAddress Source #
A parser for email addresses.
emailAddress :: ByteString -> Maybe EmailAddress Source #
Smart constructor for an email address
fromEmail :: EmailAddress -> Text Source #
emailAddressText :: Text -> Maybe EmailAddress Source #
emailToSAMLNameID :: EmailAddress -> Either String NameID Source #
FUTUREWORK(fisx): if saml2-web-sso exported the NameID constructor, we could make this
function total without all that praying and hoping.
emailFromSAML :: Email -> EmailAddress Source #
isSSOIdentity :: UserIdentity -> Bool Source #
newIdentity :: Maybe EmailAddress -> Maybe UserSSOId -> Maybe UserIdentity Source #
ssoIdentity :: UserIdentity -> Maybe UserSSOId Source #
maybeUserIdentityFromComponents :: UserIdentityComponents -> Maybe UserIdentity Source #
parsePhone :: Text -> Maybe Phone Source #
Parses a phone number in E.164 format with a mandatory leading +.
isValidPhone :: Text -> Bool Source #
Checks whether a phone number is valid, i.e. it is in E.164 format
with a mandatory leading + followed by 10-15 digits.
mkSampleUref :: Text -> Text -> UserRef Source #
For testing. Create a sample UserRef value with random seeds to make Issuer and
NameID unique. FUTUREWORK: move to saml2-web-sso.
mkSimpleSampleUref :: UserRef Source #
mkSampleUref "" ""
module Wire.API.User.Profile
2nd factor auth
data VerificationAction Source #
Constructors
| CreateScimToken | |
| Login | |
| DeleteTeam |
Instances
data SendVerificationCode Source #
Constructors
| SendVerificationCode | |
Fields | |
Instances
Protocol preferences
data BaseProtocolTag Source #
High-level protocols supported by clients.
Unlike ProtocolTag, this does not include any transitional protocols used
for migration.
Constructors
| BaseProtocolProteusTag | |
| BaseProtocolMLSTag |
Instances
newtype SupportedProtocolUpdate Source #
Constructors
| SupportedProtocolUpdate | |
Fields | |