Creating Users

Users

Users are entities that can interact with the Vertex.
They can be created and managed using the Vertex REST API Admin endpoints.

A User is identified by an API key, which is used to authenticate the User when interacting with the Vertex.
It is recommended to use different API keys for different machines using the Vertex for different purposes.

All Keys generated by a specific User can only be used by that User.
An Admin may also assign a Policy to a User, which will be applied to all Keys generated by that User.
Alternatively, a Policy can be assigned to a specific Key Share directly by an Admin.

Creating a User

To create a User, an Admin must send a GET request to the /admin/create-user endpoint.
The request may include a name query parameter, which is a human-readable, unique name for the User:

curl -L -X GET 'https://<YOUR_VERTEX>/admin/create-user?name=human-readable-name-for-user' \
-H 'Accept: application/json' \
-H 'Authorization: <ADMIN_TOKEN>'

In response, an API key will be generated for the User and returned to the Admin, together with a user_id that the Admin may then use for setting Policies for the User.