Allegion

API Reference

API: Users

The Query type in GraphQL represents the entry point for retrieving data from the API. It defines the available read-only operations (queries) that clients can execute to fetch data.

Query

Query a device and its traits by device ID. Requires read permission on the site.

device

health

Allows user to query an organization and get relevant connected information.

site

The Mutation type in GraphQL is used for modifying or creating data. It defines the operations (mutations) that allow clients to make changes to the data stored on the server, such as creating, updating, or deleting resources

Mutation

claimDeviceToSite

createSite

deleteSite

Invites a new user to the site with the input role (reference appropriate role definition documentation for details on the permissions this role is allowed).
- If user has an existing user account, they will receive the default Allegion invitation notification email, but will be automatically added to the site with the given role.
- If user does not have an existing user account, they will receive the default Allegion invitation notification email. Once they create a user account, they will be added to the site with the given role.
Note: 
- This mutation is ONLY for integration with Allegion-owned applications that utilize the default Allegion invitation email template.
- Non-Allegion applications or Allegion applications that use custom invitation templates should use the 'inviteSiteRoleWithoutEmailNotification' mutation.

inviteSiteRoleWithEmailNotification

Invites a new user to the site with the input role (reference appropriate role definition documentation for details on the permissions this role is allowed).
Invitations will not trigger any email to be sent from Allegion notifying user that they were invited.

inviteSiteRoleWithoutEmailNotification

Removes one or more roles from a user on a site.
Requires the user making the request to have 'removeRoles' permission on the site.

removeSiteRoles

unclaimDeviceFromSite

updateSite

The Subscription type in GraphQL enables real-time communication between clients and the server. It defines a set of events or data streams that clients can subscribe to and receive updates whenever the subscribed events occur.

Subscription

Objects in GraphQL represent complex data structures. They define the fields and their types that can be queried in a GraphQL API. Objects can have nested fields and relationships with other objects.

Objects

ActiveNetwork

AssemblyDate

AutoOperator

AutoOperatorActiveErrors

AutoOperatorActuatorAlternateAction

AutoOperatorActuatorTwo

AutoOperatorAutoReverse

AutoOperatorCalibrationResults

AutoOperatorClosingSwing

AutoOperatorClosingSwingSpeed

AutoOperatorHoldOpen

AutoOperatorIgnoreAngle

AutoOperatorLockRelay

AutoOperatorLockRelayLockDelay

AutoOperatorLockRelayPreloadRelease

AutoOperatorOpeningSwing

AutoOperatorOpeningSwingBackcheckSpeed

AutoOperatorPowerAssist

AutoOperatorPowerBoost

AutoOperatorPowerBoostMode

AutoOperatorPushAndGo

AutoOperatorPushAndGoMode

AutoOperatorSafetySensor

AutoOperatorSafetySensorActionOnObstruction

AutoRelockDelay

BehaviorOnPowerFailure

BlinkSpeed

Input required to claim a device to an existing site entity.

ClaimDeviceInput

Response from claiming a device to a site.

ClaimDeviceResponse

Connectivity

Current

DaylightSaving

Deadbolt

DeadboltPosition

Device

DeviceInformation

DeviceType

Information on a model and its supported capabilities.

DtmiModel

Information on the trait capabilities supported by the specific device model.

DtmiModelSupportedCapabilities

EncryptionAlgorithm

EndRule

EventPreferences

Firmware

HealthMutationResult

IndicatorBlinksWhenLocked

InteriorPushButton

Input required to invite a user to a site via email notification with a specific role

InviteRoleWithEmailInputs

Customizable details for the notification email that is sent to users.

InviteRoleWithEmailNotificationInputs

Input required to invite a user to a site without sending an email notification

InviteRoleWithoutEmailInputs

LocalSettings

Lock

LockFunction

LockMode

OrderByInput

An organization is a grouping of sites and user associations by which site owner representatives and software developers organize and manage their Allegion resources.

Organization

OrganizationSitesConnection

OrganizationSitesConnectionEdge

PageInfo

RemovedSiteRole

Input required to remove roles from a user on a site

RemoveSiteRolesInput

RemoveSiteRolesInputRole

Response from removing roles from a user on a site

RemoveSiteRolesResponse

A response indicating the status of a request

RequestStatusResponse

Role

ScheduledUpdate

A site is a physical location that contains one or more devices.

Site

Input required to create or update a site

SiteInput

SiteInviteResponse

Input required to update an existing site entity

SiteUpdateInput

SiteUsersConnection

SiteUsersConnectionEdge

StartRule

Time

Input required to unclaim a device from an existing site.

UnclaimDeviceInput

UnclaimDeviceResponse

User

UserInterfaceSettings

UserInterfaceSettingsBeeper

Wifi

Scalars: Scalars in GraphQL represent primitive data types, such as String, Int, Boolean, Float, etc. They are used to define the types of individual fields in the GraphQL schema.

Scalars

Represents a boolean value that can be either true or false.

Boolean

Custom Scalar that accepts a string that is a valid email address.

EmailString

A signed double-precision floating-point value.

Float

A unique identifier, often used to refetch an object or as a key for caching.

String

Custom Scalar that accepts a string that is a valid ISO8601 format UTC Date Time (e.g. YYYY-MM-DDThh:mm:ss.sssZ)

UtcDateTime

Custom Scalar that accepts a string that is a valid ISO8601 format UTC Date Time (e.g. YYYY-MM-DDThh:mm:ss.sssZ), but value must be within 30 days

UtcDateTimeWithin30Days

Directives in GraphQL provide a way to control the execution behavior of queries and mutations. They allow you to modify the result, change the execution order, skip or include fields conditionally, and apply custom logic to the resolution process.

Directives

Enums in GraphQL define a set of possible values for a field. They represent a discrete set of options or states that a field can have. Enums help ensure type safety and provide a clear list of valid values for a field.

Enums

MarketType

monthNameEnum

Direction (ascending or descending) in which the list should sort.

OrderByDirection

Field parameter by which list should be sorted.

SiteListOrderByFields

SiteRoleName

weekdayNameEnum

Unions in GraphQL allow you to combine multiple object types into a single type. They represent a result that can be one of several object types. Unions are useful when a field can return different types of objects, and you want to specify all the possible types in the schema.

Unions

Blank

Yonomi User API

Production

Sandbox

Email address that should be listed as the sender. Note: Email MUST end in @allegion.com.

emailFromAddress

Name of the app / team that the notification is sent from.

emailFromName

Url to post as a link where email template calls for {{redirectUrl}}. This should be the URL where user is directed to upon logging into their profile.

Sections

InviteRoleWithEmailNotificationInputs

InviteRoleWithEmailNotificationInputs

What made this section unhelpful for you?

What made this section unhelpful for you?