About the O Series User Management and Role Management APIs

📘

Note:

The User Management APIs are available for O Series and On-Premise and On-Demand deployments. These APIs are not currently available for O Series Cloud.

Efficiently manage user access in Vertex® O Series On-Premise and On-Demand, ensuring that your team members have the appropriate permissions to perform their tasks. Manage users and their assigned details, partitions, and roles. Depending on the access key that you are using, you can securely manage users using commonly available API development and testing tools.

The O Series User and Role Management APIs include:

• The user management controller - UserMgmtController
• The roles management controller - RolesController

Use these APIs to:

• Create users.
• Update users.
• Retrieve lists of users by enabled status, username, password expiration dates, role, or partition.
• Retrieve specific users by UUID.
• Retrieve a list of all roles available in the instance.

User and Role Management OAS files

Use these links to download the OpenAPI Specification (OAS) file for the O Series User Management and Role Management APIs:

About Users in O Series

There is one thing that every member of your organization needs to take advantage of Vertex O Series On-Premise and On-Demand features - to be an O Series user. Users are the people in your organization who need access to O Series functionality.

A user in O Series On-Premise and On-Demand includes these fields:

What are the user roles in O Series On-Premise and On-Demand?

A role is a collection of unique permissions that grant a user access to specific O Series features and restrict access to selected taxpayers. Each user must be assigned at least one role, but can be assigned more than one role.

There are several Vertex-defined roles in O Series On-Premise and On-Demand:

• Master Administrator
• Partition System Administrator
• On-Demand System Administrator
• Managing Tax Professional
• User Role
• API User

You can also customize user-defined roles for your specific business scenarios.

Which roles can set up a user in O Series On-Premise and On-Demand?

A Master Administrator can manage users who have access to all partitions.

A Partition System Administrator is responsible for the users and data in a given partition. This person manages users whose access is limited to a given partition.

What are the password requirements for users in O Series?

Passwords for O Series On-Premise and On-Demand are case-sensitive and must contain a combination of the following:

• One or more English lowercase characters (a through z)
• One or more English uppercase characters (A through Z)
• One or more numbers (0 through 9)

The minimum length of a password, by default, is six characters. The maximum length of a password is 16 characters.

Additional information about users in O Series On-Premise and On-Demand

See Security in the O Series User Interface in vertex Community for additional details on users and role management in On-Premise and On-Demand deployments,.

URL for accessing User Management and Role Management API endpoints

The O Series On-Demand and On-Premise URLs for accessing the User Management RESTful API endpoints is in the following format:

<server:port>//oseries-auth/<version>/<endpoint>

Where:

• <server:port> identifies your network address.
• oseries-auth designates the O Series Authorization Server RESTful API.
• <version> is the version of the API.
• <endpoint> is the target of the interaction.

For example:

https://example.server.com:8095/oseries-auth/v2/users

User Management API endpoints

Role Management API Endpoints