DatumHueEnterprise v0.0.24datumhue.com
Contents

namespaceIdentity9 functions

datumhue.identity

Sign-in with the deployment's identity provider: start sign-in/sign-out and read the signed-in identity's claims.

Functions 9

datumhue.identity.sign_in

function
datumhue.identity.sign_in(opts: identity.SignInOptions)

Start signing in with the identity provider issuer names. The scopes requested are the issuer's configured ones; a caller cannot widen them. Outcomes arrive via datumhue.events. From the root app, a sign-in started while another runs replaces it: the running one ends with no event, and the sign-in page opens again. From any other app, the parent gets an app_identity_sign_in_request to answer.

Example
datumhue.events.on("identity_signed_in", function()
    print("Signed in as", datumhue.identity.email())
end)
datumhue.identity.sign_in({
    issuer = "datumhue",
    login_hint = "ada@example.com",
})

opts identity.SignInOptions options 3 keys

KeyTypeDefaultDescription
issuer requiredstringno defaultName of the configured identity provider to sign in with.
promptstringthe provider decides what its sign-in page asks forWhat the provider's sign-in page asks for, passed to it as given: "login" asks for the credentials again, "consent" asks the user to approve access again.
login_hintstringthe sign-in page starts emptyThe account the provider's sign-in page is pre-filled with, typically an email address.

In the guide: Sign people in

datumhue.identity.cancel_sign_in

function
datumhue.identity.cancel_sign_in()

End the running sign-in: in a browser the sign-in window the workstation opened closes; elsewhere the sign-in page can no longer complete it. Every app then gets identity_sign_in_failed with error_kind = "cancelled". Does nothing while no sign-in runs. Root app only: raises from any other app.

In the guide: Sign people in

datumhue.identity.sign_out

function
datumhue.identity.sign_out()

Sign out on this workstation: every app and window here signs out, and the sign-in is ended at the deployment where its sign-in service supports that; sign-ins on other devices continue, though a Keycloak sign-in service before 26.1 can end them too. The workstation's sessions on sign-in-gated filesystem and data mounts close: an operation on one raises while no one is signed in, and opens it again as whoever signs in next. Outcome arrives via datumhue.events.

In the guide: Sign people in

datumhue.identity.is_signed_in

function
datumhue.identity.is_signed_in() -> boolean

Whether an identity is currently signed in.

In the guide: Sign people in

datumhue.identity.sub

functionneeds identity
datumhue.identity.sub() -> string?

Signed-in subject id, or nil.

In the guide: Sign people in

datumhue.identity.issuer

functionneeds identity
datumhue.identity.issuer() -> string?

Issuer of the current identity, or nil.

In the guide: Sign people in

datumhue.identity.email

functionneeds identity
datumhue.identity.email() -> string?

Email claim of the current identity, or nil, as the identity provider sent it, verified or not: the address is verified only when identity.claims().email_verified is true.

In the guide: Sign people in

datumhue.identity.name

functionneeds identity
datumhue.identity.name() -> string?

Name claim of the current identity, or nil.

In the guide: Sign people in

datumhue.identity.claims

functionneeds identity
datumhue.identity.claims() -> table?

Every claim of the current identity's ID token as a table, custom claims such as groups included; arrays become sequences and nested objects tables. Nil when signed out, and for a sign-in restored at start-up until its first refresh, which identity_refreshed announces. A restored sign-in holds only sub and iss until a refresh brings an ID token that verifies.

Example
local claims = datumhue.identity.claims()
if claims and claims.groups then
    for _, group in ipairs(claims.groups) do
        print(group)
    end
end

In the guide: Sign people in

Types 1

identity.SignInErrorKind

enum
ValueDescription
"cancelled"The sign-in ended unfinished: identity.cancel_sign_in ended it, its Continue chip was dismissed, or nobody finished it within 5 minutes.
"declined"A managing app declined this app's request, or dropped it unanswered. Only the app that asked receives it.
"network_error"The identity provider could not be reached, or it refused the sign-in's code.
"verification_failed"The identity provider's answer failed verification; skew_secs is set when this device's clock is off.
"issuer_not_trusted"This deployment has no identity provider for the requested issuer.
"popup_blocked"The browser blocked the sign-in window. A sign-in started again from a tap, click or key press can open it.
"flow_unavailable"The sign-in could not start on this device: its local callback could not be set up, or there is no window to show the Continue chip in.
"provider_unavailable"No identity provider is reachable.

Nested in: events.IdentitySignInFailed

datumhue.com

(c) 2026 Shuusei AB. Quote excerpts of this manual, with attribution to DatumHue, in your own documentation, tutorials, course materials, reviews, and other writing or video. Republishing it in whole or in substantial part needs written permission: support@datumhue.com.

Victor Mono is licensed under the SIL Open Font License 1.1
Copyright (c) 2024, Rune Bjørnerås (https://github.com/rubjo)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.

Try

    ↑↓ selectEnter openTab filter

    Settings

    Theme
    Text
    Print

    Keyboard shortcuts

    / or Ctrl KSearch
    ↑ ↓ EnterPick a result
    TabNext result filter
    j kNext or previous entry
    [ ]Previous or next page
    yCopy a link to the current entry
    ?These shortcuts
    EscClose

    On this page