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: [email protected]Pattern: ^[A-Za-z0-9 -_]+
firstnamestringRequired

First name of the hyper-admin

Example: JanePattern: ^[A-Za-z0-9 -_]+
lastnamestringRequired

Lastname of the hyper-admin

Example: DoePattern: ^[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%CKPattern: ^(?=.*[\\d])(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%^?=+_-]).{12,}$
Responses
200
OK
application/json
post
POST /v1/enterprise/hyperadmin HTTP/1.1
Host: service.drivequant.com
x-dq-enterprise-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "userId": "[email protected]",
  "firstname": "Jane",
  "lastname": "Doe",
  "password": "PnsPYthv4N?zI%CK"
}
{
  "userId": "374ad85a-404a-4273-8aea-c201bbb2f0e1",
  "firstname": "POSZ6143942",
  "lastname": "XJKJ5456191"
}

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

Last updated

Was this helpful?