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

post

Header parameters

x-dq-enterprise-api-keystringrequired

Enterprise API key

Body

userIdstringrequired

Unique identifier of the hyper-admin

Example: [e-mail]

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

firstnamestringrequired

First name of the hyper-admin

Example: Jane

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

lastnamestringrequired

Lastname of the hyper-admin

Example: Doe

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

passwordstring · min: 12required

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,}$

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://service.drivequant.com/v1/enterprise/hyperadmin' \
  --header 'x-dq-enterprise-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "[e-mail]",
    "firstname": "Jane",
    "lastname": "Doe",
    "password": "PnsPYthv4N?zI%CK"
  }'

200

401

409

429

200

{
  "userId": "374ad85a-404a-4273-8aea-c201bbb2f0e1",
  "firstname": "POSZ6143942",
  "lastname": "XJKJ5456191"
}

OK

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