Create a hyper-admin

This service can be used to create a new hyper-admin.

A hyper-admin can connect to the web administration interface of any team belonging to his enterprise.

Each hyper-admin must have a unique name. The service will refuse your request and return an error message if you attempt to create a team whose name is already used.

The hyper-admin password will need to be updated on the first login, then every 90 days. Each password must meet the following requirements:

• >= 12 characters

• at least one lowercase letter

• at least one uppercase letter

• at least one digit

• at least one special character: !@#$%^?=+_-

If you have your enterprise API key, you can try the API via this link.

Create a new hyper-admin

This service creates a new hyper-admin belonging to your organisation.

Each hyper-admin must have a unique identifier, and can manage all your teams and users from the DriveQuant admin dashboard.

POSThttps://service.drivequant.com/v1/enterprise/hyperadmin

Header parameters

Body

application/json

Request body for hyper-admin creation

userId*string

Unique identifier of the hyper-admin

Example: "[e-mail]"

Pattern: ^[A-Za-z0-9 -_]+

firstname*string

First name of the hyper-admin

Example: "Jane"

Pattern: ^[A-Za-z0-9 -_]+

lastname*string

Lastname of the hyper-admin

Example: "Doe"

Pattern: ^[A-Za-z0-9 -_]+

password*string

Initial password, used for the first login. Must be at least 12 characters long and contain one uppercase letter, one lowercase letter, one number, and one of the following character !@#$%^?=+_-

Example: "PnsPYthv4N?zI%CK"

Pattern: ^(?=.*[\\d])(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%^?=+_-]).{12,}$

Response

200401409429

OK

Body

application/json

userIdstring

Unique identifier of the hyper-admin

Example: "[e-mail]"

firstnamestring

Firstname of the hyper-admin

Example: "Jane"

lastnamestring

Lastname of the hyper-admin

Example: "Doe"

creationDatestring (date-time)

Date at which the hyper-admin account was created

Example: "2024-11-12T11:09:09.000+0000"

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v1/enterprise/hyperadmin', {
    method: 'POST',
    headers: {
      "x-dq-enterprise-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "[e-mail]",
      "firstname": "Jane",
      "lastname": "Doe",
      "password": "PnsPYthv4N?zI%CK"
    }),
});
const data = await response.json();

Response

200409429

{
  "userId": "[e-mail]",
  "firstname": "Jane",
  "lastname": "Doe",
  "creationDate": "2024-11-12T11:09:09.000+0000"
}

Request body

Name	Type	Description
userId	string	Hyper-admin unique identifier
firstname	string	Hyper-admin unique first name
lastname	string	Hyper-admin unique last name
password	string	Password used for the first login

Response

The table below summarizes the response parameters.

Name	Type	Description
userId	string	Hyper-admin unique identifier
firstname	string	Hyper-admin unique first name
lastname	string	Hyper-admin unique last name
creationDate	string	Date at which the account was created Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ