Identity and single sign-on
People sign in to Orchestrate through Keycloak, which is part of the install. From the console you can connect your own identity provider, turn groups into roles, require two-factor sign-in, and invite people, without opening Keycloak's admin console.
Open Identity & SSO under Admin. Providers and Groups are for platform admins. Invitations and Security are also open to organization admins, for their own organization.
Connect an identity provider
Orchestrate federates with any provider that speaks OpenID Connect or SAML 2.0, such as Microsoft Entra ID, Okta, AD FS, Ping, Google Workspace or another Keycloak. Each provider becomes a button on the sign-in page.
- Open Providers and add a provider.
- Give it an Alias and a Button label.
- Copy the values under At the identity provider and register Orchestrate with your provider: the redirect URI for OpenID Connect, or the SP entity ID and SP metadata URL for SAML.
- Fill in the provider's side:
- OpenID Connect: the Discovery URL, or the authorization, token and JWKS URLs and the issuer by hand; the Client ID and Client secret; how the secret is sent; the scopes; and PKCE (S256), on by default.
- SAML 2.0: the Metadata URL, or paste the metadata XML, or enter the SSO URL, entity ID and signing certificate by hand; the NameID format and which attribute identifies the user; the email and name attributes; and whether assertions must be signed, the provider's signature validated and requests signed.
- Choose whether to Trust email from this provider, Hide on the sign-in page, and Update profile at every sign-in.
- Save, and switch it Enabled.
An OpenID Connect client secret is never stored in a database: it goes to a Kubernetes Secret that Keycloak reads as a vault. The console only shows whether one is set. If your operator turned this store off, providers that need a client secret can't be saved from the console.
On an air-gapped network, use a provider inside your network. For SAML you can paste the metadata instead of giving a URL.
Teams users
To let Microsoft Teams recognise people who also have a Orchestrate account, set Directory object id claim on your Entra ID provider: oid over OpenID Connect, or http://schemas.microsoft.com/identity/claims/objectidentifier over SAML. Orchestrate copies it into the account at every sign-in. See Channels.
Groups and roles
A group is a set of people. A binding says what membership of the group gives: a role (viewer, developer or admin) on an organization, a folder or a project.
- Open Groups and create a group. Groups can be nested.
- Add a binding: the role and where it applies.
- Fill the group: add people directly under Members, or let a provider fill it with Group mappings.
A group mapping on a provider says "when the claim (OpenID Connect) or attribute (SAML) has this value, the person is in this group", with an exact value or a regular expression. Membership is checked again at every sign-in, so removing someone from the group at your provider removes their role in Orchestrate at their next sign-in.
Orchestrate applies bindings when the person next calls the API. Memberships that come from a group are kept apart from memberships added by hand, and never change them.
Platform admins can bind any group. An organization admin can bind groups to their own organization and to the folders and projects in it.
Two-factor sign-in
On Security:
- Everyone on this platform: Require two-factor sign-in (authenticator app). New users set up an authenticator at their first sign-in. Choose Also ask existing users to set one up to ask every current local user too.
- Per organization: require it for one organization's members, including its folders and projects.
The API enforces it, not only the sign-in page: a person who should have an authenticator and has none can't call the API, apart from finding out what to do. The console shows them a banner with a link to set one up. If Keycloak can't be asked, a check that needs MFA fails closed.
People who sign in only through an identity provider are exempt by default. Their second factor is their provider's business.
The same page switches 'Forgot password?' on the sign-in page on or off.
Invite people
On Invitations, enter an email address and, optionally, a name, an organization and a role. Then choose how the invitation goes:
| Delivery | What happens |
|---|---|
| Keycloak emails a link to set a password. Needs an SMTP server configured in Keycloak. | |
| Copyable link | Orchestrate makes a one-time link that you send however you like. It works once and expires after 72 hours. |
| Email if possible | Email when the realm has SMTP, otherwise a link. |
Copyable links are useful on installs with no email server. The token is in the part of the address after #, so it never reaches a server log, and only its hash is stored. Open links lists links not used yet, and you can revoke one.
Platform admins and organization admins can invite. The new account starts with no platform role and, unless you chose one, no membership.
Reset a password
A platform admin can reset a local user's password on the same page: Keycloak emails a link, or Orchestrate makes a copyable link that works once, for 24 hours. People who sign in through an identity provider reset their password there.
Find people
Member forms search the directory by name or email, so you don't need a person's Keycloak id. Searching is open to anyone who can manage members somewhere: a platform admin, or an admin of at least one organization, folder or project.
What is recorded
Changes to providers, groups, bindings, MFA settings and links are audit events. So are sign-ins, failed sign-ins, sign-outs, and MFA and password changes, copied from Keycloak. See Audit log.