Authenticated User List
For information on the Authenticated User List APIs, see the following URL:
https://api.app.secunia.com/api/users/
The Authenticated User List is a list of users for your account; users that have access to the system per your license agreement. The number of active users represents the number of used licenses.
API-supported endpoint actions and available methods for authenticated user list APIs include:
| • | Available Methods for Authenticated User List |
| • | Authenticated User List Fields for Create/Edit |
Available Methods for Authenticated User List
The following are available methods for Authenticated User List.
|
Method |
Description |
|
get list |
GET <URL> |
|
get instance details |
GET <URL><id>/ |
|
create instance |
POST <URL> |
|
edit instance |
PUT <URL><id>/ |
Authenticated User List Fields for Create/Edit
The following are authenticated user list fields for Create/Edit.
|
Fields |
Description |
|
username (string) |
Read only after create |
|
first_name (string) |
User first name |
|
last_name (string) |
User last name |
|
job_title (string) |
Job title |
|
title (string) |
|
|
email (string) |
The user's email address, mandatory and unique field |
|
phone_number (string) |
Phone number for two factor authentication and for SMS alerts must be in an international format, e.g. +1 201 555 1234 |
|
is_active (bool) |
Determines if the user is still valid, can log in, receive alerts etc. The active status of an user can only be enabled after creation by the user through clicking the link from the email activation that is sent by the system. |
|
country (string) |
The user's country |
|
language (string) |
The user's preferred language |
|
timezone (string) |
The user's preferred timezone |
|
user_groups (list of int) |
The user groups the user is included in, the permissions will be determined based on the user group affiliation |