Security Service
used when a user is trying to change her password. This will be the new password.
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
successful operation
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
POST /api/v1/oauth2 HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"userId": "support@example.com",
"password": "support"
}
{
"access_token": "text",
"refresh_token": "text",
"token_type": "text",
"expires_in": 1,
"idle_timeout": 1,
"username": "text",
"created": 1,
"userMustChangePassword": true,
"errorCode": 1,
"aclTemplate": {
"aclTemplate": {
"Read": true,
"ReadWrite": true,
"ReadWriteCreate": true,
"Delete": true,
"PortalLogin": true
}
}
}
successful operation
The requested operation was performed.
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
DELETE /api/v1/oauth2/{token} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
successful operation
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/systemEndpoints HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"endpoints": [
{
"type": "text",
"id": 1,
"vendor": "text",
"uri": "https://example.com",
"authenticationType": "text"
}
]
}
Selecting this option means the newest record will be returned. Use limit to select how many.
Return only the ids.
Return only the ids.
id1,id2,id3,id4,id5
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/users HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
POST /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 869
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"avatar": "https://example.com",
"email": "name@gmail.com",
"validated": true,
"validationEmail": "name@gmail.com",
"validationDate": 1,
"created": 1,
"validationURI": "text",
"changePassword": true,
"lastLogin": 1,
"currentLoginURI": "text",
"lastPasswordChange": 1,
"lastEmailCheck": 1,
"currentPassword": "text",
"lastPasswords": [
"text"
],
"waitingForEmailCheck": true,
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"location": "123e4567-e89b-12d3-a456-426614174000",
"owner": "123e4567-e89b-12d3-a456-426614174000",
"suspended": true,
"blackListed": true,
"locale": "text",
"userRole": "root",
"oauthType": "internal",
"oauthUserInfo": "text",
"securityPolicy": "text",
"securityPolicyChange": 1,
"userTypeProprietaryInfo": {
"mobiles": [
{
"number": "text",
"verified": true,
"primary": true
}
],
"mfa": {
"enabled": true,
"method": "sms"
}
}
}
No content
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
PUT /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 869
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"avatar": "https://example.com",
"email": "name@gmail.com",
"validated": true,
"validationEmail": "name@gmail.com",
"validationDate": 1,
"created": 1,
"validationURI": "text",
"changePassword": true,
"lastLogin": 1,
"currentLoginURI": "text",
"lastPasswordChange": 1,
"lastEmailCheck": 1,
"currentPassword": "text",
"lastPasswords": [
"text"
],
"waitingForEmailCheck": true,
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"location": "123e4567-e89b-12d3-a456-426614174000",
"owner": "123e4567-e89b-12d3-a456-426614174000",
"suspended": true,
"blackListed": true,
"locale": "text",
"userRole": "root",
"oauthType": "internal",
"oauthUserInfo": "text",
"securityPolicy": "text",
"securityPolicyChange": 1,
"userTypeProprietaryInfo": {
"mobiles": [
{
"number": "text",
"verified": true,
"primary": true
}
],
"mfa": {
"enabled": true,
"method": "sms"
}
}
}
No content
The requested operation was performed.
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
DELETE /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Successfully retrieved the avatar
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binary
The requested operation was performed.
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
POST /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: image/jpeg
Accept: */*
Content-Length: 8
"binary"
{
"Operation": "text",
"Details": "text",
"Code": 1
}
The requested operation was performed.
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
DELETE /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
The requested operation was performed.
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
Error description
POST /api/v1/email HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"from": "name@gmail.com",
"subject": "text",
"recipients": [
"name@gmail.com"
],
"text": "text"
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
The requested operation was performed.
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
Error description
POST /api/v1/sms HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"from": "text",
"to": "text",
"text": "text"
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Pagination start (starts at 1. If not specified, 1 is assumed)
Maximum number of entries to return (if absent, no limit is assumed)
Filter the results
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/securityProfiles HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/systemServices HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
No content
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/validateToken?token=text HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Get a value
Successful command execution
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
GET /api/v1/system?command=info HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"version": "text",
"uptime": 1,
"start": 1,
"os": "text",
"processors": 1,
"hostname": "text",
"certificates": [
{
"filename": "text",
"expires": 1
}
]
}
Successful command execution
The requested does not have sufficient rights to perform the operation.
The specified resource was not found.
POST /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"command": "setloglevel",
"subsystems": [
{
"tag": "text",
"value": "text"
}
]
}
{
"taglist": [
{
"tag": "text",
"value": "text"
}
]
}
Last updated