# Zerion Identity and Access Management OpenAPI file: https://apidocs.zerionsoftware.com/doc/zerion-identity.yaml ## Description Last update on Jun 23, 2026.

IAM OVERVIEW

IAM technology can be used to initiate, capture, record and manage user identities and their related access permissions in an automated fashion. This ensures that access privileges are granted according to one interpretation of policy and all individuals and services are properly authenticated, authorized and audited. The business IT environment is ever evolving and managing access has become a big administrative burden. Users switch between projects and as their duties change, it could result in changes to their access level. The users with privileges beyond their requirement is potentially unsafe and can lead to data loss or theft. Zerion Identity is a web service that helps you securely control access to Zerion resources for your users. You use Zerion Identity to control who can use your Zerion resources (authentication) and what resources they can use and in what ways (authorization).

GOALS

Centralize Data collector, Dataflow and future micro services login authentication and access management. Create an expandable access management system for future micro services.

SPECIFICATIONS

Zerion Identity and Access consists of the following core objects

Users

An user is an entity that you create in Zerion Identity to represent the person or service using it when interacting with Zerion Identity. A primary use for users is to give people you work with the ability to sign in to the Zerion Identity Management Console for interactive tasks and to make programmatic requests to Zerion Identity services using the API. A user in Zerion Identity consists of a name, a password to sign into the Zerion Identity Management Console, and up to two devices associated with the SQRL login keys. When a user is created, an unique randomized entity key is generated for that user.

User Groups

An group is a collection of users. You can use groups to specify permissions for a collection of users, which can make those permissions easier to manage for those users. For example, you could have a group called Admins and give that group the types of permissions that administrators typically need. Any user in that group automatically has the permissions that are assigned to the group. If a new user joins your organization and should have administrator privileges, you can assign the appropriate permissions by adding the user to that group. Similarly, if a person changes jobs in your organization, instead of editing that user's permissions, you can remove him or her from the old groups and add him or her to the appropriate new groups. Note that a group is not truly an identity because it cannot be identified as a Principal in an access policy. It is only a way to attach policies to multiple users at one time.

Permissions

Permissions let you specify who has access to Zerion resources, and what actions they can perform on those resources. Every Zerion Identity user starts with no permissions. In other words, by default, users can do nothing. To give a user permission to do something, you can add the permission to the user (that is, attach a policy to the user) or add the user to a group that has the desired permission. For example, you might grant a user permission to list his or her own details. You might also expand that permission and also let each user create, update, and delete their SQRL keys. When you give permissions to a group, all users in that group get those permissions. For example, you can give the Admins group permission to perform any of the Zerion Identity actions on any of the Zerion account resources. Another example: You can give the Managers group permission to list the forms in that particular Zerion account.

General Notes:

  • Most list based requests will return a maximum of 100 objects per request (Users, User Groups, and Permissions).
  • Default response will be returned when invalid grammar is passed into the request.
  • Field grammar can include filters (single or multiple conditions) and sort order.

    • Using Parameters

  • Parameters will allow you to refined the request and consist of the following:
  • fields: Allow you to specify which attributes are returned. Filter and sort priority can be assigned to each field.
  • limit: Allow you to specify how many results are returned.
  • offset: Allow you to specify number of results to skip.
  • For example, this url would only provide the user ids and names.
    https://identity.zerionsoftware.com/v1/users
  • This example demonstrates returning first name, last name, and profile id. This will also skip the first record only display 2 after that.
    https://identity.zerionsoftware.com/v1/users?fields=firstName,lastName,profileId&offset=1&limit=2

    • Sorting Fields:

  • To sort by column(s), there are three components:
  • Column: The field you want to sort by
  • Operator: These consist of < (ascending) and > (descending)
  • Sort Priority: When sorting by multiple columns, you set priority by designating a number after the operator.
  • In this example, lastName has first priority in ascending order followed by firstName in descending order.
    https://identity.zerionsoftware.com/v1/users?fields=firstName:>2,lastName:<1

    • Filtering Fields:

    Adding filters will narrow down your request output or input. This can be used with both GET and PUT requests.
    GET: Will return any data that meets your filter’s rules.
    PUT: Instead of updating a specific record, update many records that match the filter. For example, changing everyone who is now over 18 from child to an adult.

  • Three Components of Filtering
  • Column: The field you want to filter
  • Operator: These consist of <, <=, >, >=, = and ~
  • Value:The value you are basing your filter on. Boolean values can be passed in either as true and false, or 0 and 1.
  • Examples
  • Get everyone who is between Profile Id 161658 AND 161705 (Note: the '&' symbol may need to be url encoded which is '%26')
    profileId((>="161658")&(<="161705"))

    or encoded
    profileId((>="161658")%26(<="161705"))
  • Get everyone that Profile Id is less than or equal to 161658 OR more than 161705
    profileId((<="161658")|(>="161705"))
  • Get all usernames that start with 'K'
    username(~"K%")
  • Get all usernames that end with 'son'
    username(~"%son")
  • Get all usernames that contain 'mit'
    username(~"%mit%")
  • Now combining the examples above in a URL.
    https://identity.zerionsoftware.com/v1/users?fields=profileId((>="161658")%26(<="161705")),username(~"demo%")
  • Searching Multiple Specific Values
  • This will allow you to pass in multiple specifc values you want the query to return. Form example,
  • Get both records for username kjohnson AND mjordan
    username(="kjohnson"|="mjordan")
    • ## Servers - https://identity.zerionsoftware.com/v1: https://identity.zerionsoftware.com/v1 () ## Authentication ## Endpoints ### [User Resource](https://apidocs.zerionsoftware.com/doc/zerion-identity/group/endpoint-user-resource.md) - [Retrieve a List of Users](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-users.md) - [Update a List of Users](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-put-users.md) - [Create New Users](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-post-users.md) - [Delete a List of Users](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-users.md) - [Retrieve a user](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-users-user-id.md) - [Update a User](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-put-users-user-id.md) - [Delete a User](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-users-user-id.md) ### [User Group Resource](https://apidocs.zerionsoftware.com/doc/zerion-identity/group/endpoint-user-group-resource.md) - [Retrieve a List of User Groups](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-user-groups.md) - [Update a List of User Groups](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-put-user-groups.md) - [Create New User Groups](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-post-user-groups.md) - [Delete a List of User Groups](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-user-groups.md) - [Retrieve a user group](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-user-groups-user-group-id.md) - [Update a User Group](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-put-user-groups-user-group-id.md) - [Delete a User Group](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-user-groups-user-group-id.md) - [Retrieve a User Group User Assignment](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-user-groups-user-group-id-users.md) - [Assign User to User Group](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-post-user-groups-user-group-id-users.md) - [Unassign User from User Group](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-user-groups-user-group-id-users.md) ### [Policy Resource](https://apidocs.zerionsoftware.com/doc/zerion-identity/group/endpoint-policy-resource.md) - [Retrieve a List of Policies](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-policies.md) - [Update a List of Policies](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-put-policies.md) - [Create New Policies](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-post-policies.md) - [Delete a List of Policies](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-policies.md) - [Retrieve a policy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-policies-policy-id.md) - [Update a Polilcy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-put-policies-policy-id.md) - [Delete a Policy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-policies-policy-id.md) - [Retrieve a Policy User Group Assignment](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-policies-policy-id-user-groups.md) - [Assign User Group to Policy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-post-policies-policy-id-user-groups.md) - [Unassign User Group from Policy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-policies-policy-id-user-groups.md) - [Retrieve a Policy User Assignment](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-get-policies-policy-id-users.md) - [Assign User to Policy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-post-policies-policy-id-users.md) - [Unassign User from Policy](https://apidocs.zerionsoftware.com/doc/zerion-identity/operation/operation-delete-policies-policy-id-users.md) [Powered by Bump.sh](https://bump.sh)