UsherAPITask Enumeration Reference
UsherAPITask
public enum UsherAPITaskAn enum for different API request tasks to Usher Server. These values are
used to initialize and configure an UsherAPIRequestConfiguration instance.
-
Get Server TLS Certificate
Declaration
Swift
case ServerTLSCertificate -
Get server version
Declaration
Swift
case ServerVersion -
Get server configuration
Declaration
Swift
case ServerConfiguration -
Request client certificate
Declaration
Swift
case RequestClientCertificate -
Request client certificate renewal code
Declaration
Swift
case RequestClientCertificateRenewalCode -
Renew client certificate with a renewal code.
Declaration
Swift
case RenewClientCertificate(renewalCode: String)
-
Renew access tokens with a refresh token
Declaration
Swift
case RenewTokens(refreshToken: String) -
Register Apple push notification token with server.
Declaration
Swift
case RegisterAPNSToken(token: String)
-
Retrieve recovery code for all badges by receiving an email.
Declaration
Swift
case RetrieveRecoveryCodeForEmail(email: String) -
Request badge recovery code via email for a specific organization ID.
Declaration
Swift
case RequestRecoveryCodeForEmail(email: String, orgId: String?) -
Recover badges by a recovery code.
Declaration
Swift
case RecoverBadgeByRecoveryCode(code: String) -
Recover badges by an invitation code.
Declaration
Swift
case RecoverBadgeByInvitationCode(code: String) -
Recover AD badge with credentials
Declaration
Swift
case RecoverBadgeByCredentials(orgId: String, username: String, password: String) -
Get badge info for badge ID
Declaration
Swift
case Badge(id: String) -
Get organization info for an organization ID
Declaration
Swift
case GetOrganizationInfo(id: String)
-
Request two factor authentication code for a badge and enrolled phone number.
Declaration
Swift
case Request2FACodeForBadge(id: String, phoneNumber: String) -
Verify two factor authentication code for a badge
Declaration
Swift
case Verify2FACodeForBadge(id: String, code: String) -
Verify two factor authentication code for a badge deletion on a device.
Declaration
Swift
case Verify2FACodeForBadgeDeletion(id: String, deviceId: String, code: String)
-
Delete a badge by providing the badge ID
Declaration
Swift
case DeleteBadge(id: String) -
Delete a badge from a different device.
Declaration
Swift
case DeleteBadgeFromDevice(id: String, deviceId: String) -
Set user’s terms of use and privacy policy acceptance for a badge ID.
Declaration
Swift
case UserAgreement(termsOfUseAccepted: Bool, privacyPolicyAccepted: Bool, badgeId: String)
-
Fetch user’s profile image for a badge ID.
Declaration
Swift
case FetchUserProfileImageForBadge(id: String) -
Update user’s profile image for badge ID. This task can also be used to set profile picture for the first time.
Declaration
Swift
case UpdateUserProfileImageForBadge(id: String, image: Data) -
Fetch organization icon for a badge and icon URL.
Declaration
Swift
case FetchIconForBadge(id: String, iconURL: String) -
Fetch background image for a badge and image URL.
Declaration
Swift
case FetchBackgroundImageForBadge(id: String, imageURL: String)
-
Fetch add physical access keys for a badge.
Declaration
Swift
case KeysForBadge(id: String) -
Fetch favorite physical access keys for a badge.
Declaration
Swift
case FavoriteKeysForBadge(id: String) -
Save user’s favorite keys for a badge with a keysJSON string. This task overrites all the favorite keys on the server, so make sure to include all favorite keys when adding or removing a single key.
Declaration
Swift
case SaveFavoriteKeysForBadge(id: String, keysJSON: String) -
Use a key to access a physical resource.
Declaration
Swift
case UseKey(id: String, resourceId: String?, groupKey: Bool)
-
Fetch symmetric keys for Usher Code and TOTP.
Declaration
Swift
case FetchSymmetricKeyForBadge(id: String, lastKeyId: String?, lastSightKeyId: String?, version: Int) -
Acknowledge symmetric key for badge
Declaration
Swift
case AcknowledgeSymmetricKeyForBadge(id: String, orgId: String, lastKeyId: String, version: Int)
-
Report user’s locations associated to a badge to the server.
Declaration
Swift
case ReportLocation(locations: [CLLocation], badgeId: String)
-
Verify a scanned QR code. See
VerifyQRConfigfor configuration.Declaration
Swift
case VerifyQR(config: VerifyQRConfig)
-
Record a scanned non-usher code. See
GenericCodeScanConfigfor configuration.Declaration
Swift
case RecordGenericCodeScan(config: GenericCodeScanConfig) -
Verify an Usher user using a scanned code. See
UserVerificationRequestfor configurationDeclaration
Swift
case VerifyUser(request: UserVerificationRequest)
-
Fetch inbox items for
InboxAPIRequestType, badge ids and current badge IDDeclaration
Swift
case LoadInboxItems(requestType: InboxAPIRequestType, badgeIds: [String], currentBadgeId: String) -
Reply to an inbox message with the reply index and badge ID.
Declaration
Swift
case ReplyToInboxMessage(notificationId: String, replyIndex: Int, badgeId: String)
-
Approve a VPN connection request. See also
VPNRequest.Declaration
Swift
case ApproveVPN(request: VPNRequest) -
Reject a VPN connection request. See also
VPNRequest.Declaration
Swift
case RejectVPN(request: VPNRequest)
-
Fetch all beacons for an organization
Declaration
Swift
case GetBeaconsForOrganization(id: String) -
Trigger an action for an actionable becon.
Declaration
Swift
case TriggerActionForBeaconRegion(regionId: String, badgeId: String, actionType: String, beacon: CLBeacon?, exit: Bool)
-
Online desktop pairing initialization
Declaration
Swift
case PairingInitializationOnline(params: DesktopPairingParams) -
Fetch desktop credentials submitted at pairing step on the desktop
Declaration
Swift
case PairingCredentialFetch(params: DesktopPairingCredentialFetchParams) -
Submit desktop credentials for unlocking
Declaration
Swift
case UnlockCredentialSubmit(params: DesktopUnlockCredentialSubmitParams) -
Sync desktop pairing info to server
Declaration
Swift
case SyncDesktopConfig(info: DesktopPairingInfo) -
Report desktop related event.
Declaration
Swift
case ReportDesktopEvent(event: DesktopReportEvent)