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
refresh_token
POST /api/v1/oauth2 HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
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
}
}
}
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
refresh_token
POST /api/v1/suboauth2 HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
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
}
}
}
The requested operation was performed.
DELETE /api/v1/oauth2/{token} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
The requested operation was performed.
DELETE /api/v1/suboauth2/{token} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/systemEndpoints HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
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
Name matching
Name matching
GET /api/v1/users HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
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
Name matching
Name matching
GET /api/v1/subusers HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
POST /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 963
{
"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,
"modified": 1,
"userTypeProprietaryInfo": {
"mobiles": [
{
"number": "text",
"verified": true,
"primary": true
}
],
"authenticatorSecret": "text",
"mfa": {
"enabled": true,
"method": "sms"
}
},
"signupUUID": "123e4567-e89b-12d3-a456-426614174000"
}
No content
false
false
PUT /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 963
{
"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,
"modified": 1,
"userTypeProprietaryInfo": {
"mobiles": [
{
"number": "text",
"verified": true,
"primary": true
}
],
"authenticatorSecret": "text",
"mfa": {
"enabled": true,
"method": "sms"
}
},
"signupUUID": "123e4567-e89b-12d3-a456-426614174000"
}
No content
DELETE /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
GET /api/v1/subuser/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
POST /api/v1/subuser/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 963
{
"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,
"modified": 1,
"userTypeProprietaryInfo": {
"mobiles": [
{
"number": "text",
"verified": true,
"primary": true
}
],
"authenticatorSecret": "text",
"mfa": {
"enabled": true,
"method": "sms"
}
},
"signupUUID": "123e4567-e89b-12d3-a456-426614174000"
}
No content
false
false
PUT /api/v1/subuser/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 963
{
"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,
"modified": 1,
"userTypeProprietaryInfo": {
"mobiles": [
{
"number": "text",
"verified": true,
"primary": true
}
],
"authenticatorSecret": "text",
"mfa": {
"enabled": true,
"method": "sms"
}
},
"signupUUID": "123e4567-e89b-12d3-a456-426614174000"
}
No content
DELETE /api/v1/subuser/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
GET /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
binary
POST /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: image/jpeg
Accept: */*
Content-Length: 8
"binary"
{
"Operation": "text",
"Details": "text",
"Code": 1
}
DELETE /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
POST /api/v1/email HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
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
}
POST /api/v1/sms HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"from": "text",
"to": "text",
"text": "text"
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
POST /api/v1/userPreferences HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"modified": 1,
"data": [
{
"tag": "text",
"value": "text"
}
]
}
No content
PUT /api/v1/submfa HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "disabled",
"email": "name@gmail.com",
"sms": "text"
}
No content
false
GET /api/v1/totp HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
binary
1,2,3
PUT /api/v1/totp HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"nextIndex": 1,
"moreCodes": true
}
POST /api/v1/signup HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
PUT /api/v1/signup HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"reason": "text",
"time": 1,
"errorCode": 1
}
{
"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
GET /api/v1/securityProfiles HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/systemServices HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/validateToken HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/validateSubToken HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
Get a value
GET /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"version": "text",
"uptime": 1,
"start": 1,
"os": "text",
"processors": 1,
"hostname": "text",
"certificates": [
{
"filename": "text",
"expires": 1
}
]
}
POST /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"command": "setloglevel",
"subsystems": [
{
"tag": "text",
"value": "text"
}
]
}
{
"taglist": [
{
"tag": "text",
"value": "text"
}
]
}