COSMO

COSMO Connect provides user, profile, and access permission management through a custom Make app. It allows you to create and update users, assign time‑bound access permissions, and search or list profiles, sites, and users. When used in Make scenarios, this app centralises access-control workflows, including onboarding/offboarding users, granting temporary access, and auditing who has access to what.

What COSMO modules are available in the Make platform

  • User – Create a User, Update a User, Get a User, Delete a User, Search Users, Get a User Outcode
  • Permission – Create Access Permission, Update Access Permission, Delete a Permission, Search Access Permissions, Get an Access Permission
  • Groups - Get a Group, Create a Group, Update a Group
  • Profiles – Get a Profile, List all Profiles
  • Sites - List all Sites
  • Other – Make an API Call

Connecting COSMO to Make

How do I request a BPT App License Key

After purchasing your app either as part of a bundle or separately, you should have received an email containing the BPT App License Key. If you have not received an email or if you are yet to purchase the app please use the Frequently Asked Questions that will guide you through the process.

How to Create a connection for your Make module

  1. To establish the connection in Make, insert a COSMO module into a scenario. Under Connection, click “Create a connection”.
  2. The Create a Connection dialog appears.
  3. In the Connection name field, enter a name to identify the connection.
  4. Enter your Registered BPT App License Key.
Create a connection
  1. Enter COSMO Domain Name for example, http://blueprecision.cosmo.com/access input blueprecision.cosmo.com as the domain name.

  2. Input Username and Password for COSMO

  3. Click Save.

Build COSMO Scenarios

After connecting the app, you can perform the following actions:

Permission

Get an Access Permission

Retrieve a single access permission by its ID.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Permission ID *The unique identifier of the permission to retrieve. (Required)

Create Access Permission

Create a new access permission for a user and profile within a date range.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
User ID *Identifier of the user to assign the permission to. A search button allows you to look up the user using First Name and Surname. (Required)
Profile IDSelect the profile to associate with the permission.
Start Date *Start date and time for the permission. Implemented as a collection of Date and Time fields. (Required)
End Date *End date and time for the permission. Implemented as a collection of Date and Time fields. (Required)

Update Access Permission

Update an existing access permission, including user, profile, and date range.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Permission ID *The unique identifier of the permission to update. (Required)
User ID *Identifier of the user associated with the permission. Includes a search button to look up the user by First Name and Surname. (Required)
Profile IDSelect the profile to associate with the permission.
Start Date *Updated start date and time for the permission (collection of Date and Time). (Required)
End Date *Updated end date and time for the permission (collection of Date and Time). (Required)

Delete a Permission

Delete an existing access permission by its ID.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Permission ID *The unique identifier of the permission to delete. (Required)

Search Access Permissions

Search access permissions using multiple filters such as permission ID, user, profile, and limit.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Permission IDFilter by permission ID.
User IDFilter by user. A search button allows you to look up the user using First Name and Surname.
Profile IDFilter by profile.
LimitMaximum number of returned results (bundles). Default is 10.

User

Create a User

Create a new user in the COSMO system.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
First Name *User’s first name. (Required)
SurnameUser’s surname.
Email Address *User’s email address. (Required)
Phone NumberUser’s phone number.
Profile IDSelect the profile to assign to the user.
Group IDSelect the group to assign to the user.
Activation Date *Date from which the user becomes active. (Required)
Expiry DateOptional expiry date for the user.
Set Active *Indicates whether the user should be active. Defaults to false. (Required)
IncodeOptional Incode associated with the user.

Update a User

Update an existing user’s details and status.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
User ID *The unique identifier of the user to update. (Required)
First Name *User’s first name. (Required)
Surname *User’s surname.
Email Address *User’s email address. (Required)
Phone NumberUser’s phone number.
Profile IDSelect the profile to assign to the user.
Group IDSelect the group to assign to the user.
Activation Date *Date from which the user becomes active. (Required)
Expiry Date *Optional expiry date for the user.
Set Active *Indicates whether the user should be active. Defaults to false. (Required)
IncodeOptional Incode associated with the user.

Get a User

Retrieve a single user by their ID.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
User ID *The unique identifier of the user to retrieve. (Required)

Delete a User

Delete an existing user by their ID.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
User ID *The unique identifier of the user to delete. (Required)

Search Users

Search users using multiple filters such as ID, name, email, phone, profile, group, and limit.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
User IDFilter by user ID.
NameFilters by first name or surname (contains).
EmailFilters by Email (contains).
Phone NumberFilters by Phone Number (contains).
Profile IDFilter by profile.
Group IDFilter by group.
LimitNumber of results to return. Defaults to 10.

Get a User Outcode

Retrieve a user’s outcode using their user ID and incode.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
User ID *The unique identifier of the user. (Required)
Incode *The incode value used for the lookup. (Required)

Groups

Get a Group

Retrieve a single group by its ID.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Group ID *The unique identifier of the group to retrieve. (Required)

Create a Group

Create a new group in COSMO.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Description *Description for the group. (Required)

Update a Group

Update an existing group in COSMO.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Group ID *The unique identifier of the group to update. (Required)
Description *Updated description for the group. (Required)

Profiles

Get a Profile

Retrieve a single profile by its ID.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
Profile ID *The unique identifier of the profile to retrieve. (Required)

List all Profiles

Returns a list of profiles available in COSMO.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
LimitMaximum number of returned results (bundles). Default is 10.

Sites

List all Sites

Returns a list of sites available in COSMO.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
LimitMaximum number of returned results (bundles). Default is 10.

Other

Make an API Call

Performs an arbitrary authorised API call.

This module contains the following fields

FieldDescription
ConnectionSelect the required connection from the drop‑down. If no connection exists, create a Connection.
URL *Enter a path relative to https://{{connection.hostname}}. For example: /users. (Required)
Method *Select the HTTP method you want to use: GET to retrieve information, POST to create a new entry, PUT to update/replace an existing entry, PATCH to make a partial entry update, DELETE to delete an entry. (Required)
HeadersEnter the desired request headers as key/value pairs. You don’t have to add authorisation headers; these are already included. A default Content-Type: application/json header is provided.
Query StringEnter the request query string as key/value pairs.
BodyEnter the body content for your API call.