User Control

The User Control app is an app that provides information about the current user and allows for the user to configure settings such as cookie consent.

WARNING

For this app to function, it requires the Alliance Data backend.
Please note that this backend is exclusively accessible to developers from team Alliance.

How to install

1. Install as developer dependency

   npm install -D @alliance/app-user-control --registry https://registry.webprovisions.io

2. Add app to your Alliance configuration file.

   // alliance.config.ts
   import { defineConfig } from '@alliance/framework/config';
   
   export default defineConfig({
     server: {
       apps: ['@alliance/app-user-control'],
     },
   });

Capabilities

No available capabilities.

Managed Objects

currentUser

Object containing information about the current user.

Example

// app.ts
import { queryObjects } from '@alliance/framework';

const query = queryObjects('currentUser');

const currentUser = await query.resolve();

Object Type

Property	Type	Description
firstName	string	Users first name
lastName	string	Users last name
email	string	Users email address
id	string	Users id
roles	string[]	Users roles
applications	Applications[]	Array of applications the user has access to
username	string	Users username

Applications

Property	Type	Description
applicationId	string	Application id
applicationInstanceId	string	Application instance id
applicationName	string	Application name
applicationType	string	Application type/slug

Query Args

No arguments.

currentWorkspace

Object containing information about the current workspace.

Example

// app.ts
import { queryObjects } from '@alliance/framework';

const query = queryObjects('currentWorkspace');

const currentWorkspace = await query.resolve();

Object Type

Property	Type	Description
id	string	Workspace id
name	string	Workspace name
slug	string	URL friendly workspace name

Query Args

No arguments.

currentOrganization

Object containing information about the current organization.

Example

// app.ts
import { queryObjects } from '@alliance/framework';

const query = queryObjects('currentOrganization');

const currentOrganization = await query.resolve();

Object Type

Property	Type	Description
id	string	Organization id
name	string	Organization name
slug	string	URL friendly workspace name
idp	'OIDC' | 'SAML' | 'DIRECTORY' | undefined	Organization IdP type
passwordPolicy	PasswordPolicy | undefined	Organization password policy

PasswordPolicy

Property	Type	Description
enabled	boolean	Whether the password policy is enabled
minimumLength	number	The minimum length of the password
requireUppercase	boolean	Whether the password must contain an uppercase letter
requireLowercase	boolean	Whether the password must contain a lowercase letter
requireNumber	boolean	Whether the password must contain a number
requireSymbol	boolean	Whether the password must contain a symbol

Query Args

No arguments.