Security Service

PreviousOpenAPI Definitions NextGateway Service

Last updated 2 years ago

Retrieve the system layout.

get

Authorizations

Responses

application/json

objectoptional

application/json

get

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"
    }
  ]
}

Retrieve a list of existing users as well as some information about them.

get

Authorizations

Query parameters

offsetinteger · int64optional

limitinteger · int64optional

filterstringoptional

Selecting this option means the newest record will be returned. Use limit to select how many.

idOnlybooleanoptional

Return only the ids.

selectstringoptional

Return only the ids.

Example: id1,id2,id3,id4,id5

Responses

application/json

get

GET /api/v1/users HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Retrieve the information for a single user.

get

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

get

GET /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Delete a single user.

delete

Authorizations

Path parameters

idinteger · int64required

Responses

application/json

objectoptional

application/json

delete

DELETE /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

Retrieve the avatar associated with a user ID.

get

Authorizations

Path parameters

idstring · uuidrequired

Responses

string · binaryoptional

application/json

get

GET /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

binary

Remove an avatar associated with a user ID.

delete

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/v1/avatar/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

Retrieve the list of security profiles for a specific service type.

get

Authorizations

Query parameters

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

Responses

application/json

get

GET /api/v1/securityProfiles HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Retrieve the basic system information. This information is used between services only.

get

Authorizations

Responses

application/json

get

GET /api/v1/systemServices HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Allows any microservice to validate a token and get security policy for a specific user.

get

Authorizations

Query parameters

tokenstringrequired

Responses

application/json

get

GET /api/v1/validateToken HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Retrieve different values from the running service.

get

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

Responses

application/json

one ofoptional

application/json

get

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
    }
  ]
}

Revoke a token.

delete

Authorizations

Path parameters

tokenstringrequired

Responses

application/json

anyoptional

The requested operation was performed.

application/json

delete

DELETE /api/v1/oauth2/{token} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*

No Content

Get access token - to be used as Bearer token header for all other API requests.

post

Authorizations

Query parameters

newPasswordstringoptional

used when a user is trying to change her password. This will be the new password.

forgotPasswordbooleanoptional

A user forgot her password. She needs to present her e-mail address in the userId and set this to true

requirementsbooleanoptional

A user forgot her password. She needs to present her e-mail address in the userId and set this to true

resendMFACodebooleanoptional

completeMFAChallengebooleanoptional

Body

one ofoptional

User Id and password.

Responses

application/json

one ofoptional

application/json

post

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
    }
  }
}

Create a single user.

post

Authorizations

Path parameters

idinteger · int64required

Query parameters

email_verificationbooleanoptional

Body

idstring · uuidoptional

namestringoptional

descriptionstringoptional

avatarstring · urioptional

emailstring · emailoptional

validatedbooleanoptional

validationEmailstring · emailoptional

validationDateinteger · int64optional

createdinteger · int64optional

validationURIstringoptional

changePasswordbooleanoptional

lastLogininteger · int64optional

currentLoginURIstringoptional

lastPasswordChangeinteger · int64optional

lastEmailCheckinteger · int64optional

currentPasswordstringoptional

lastPasswordsstring[]optional

waitingForEmailCheckbooleanoptional

notesobject[]optional

locationstring · uuidoptional

ownerstring · uuidoptional

suspendedbooleanoptional

blackListedbooleanoptional

localestringoptional

userRolestring · enumoptionalAvailable options:

oauthTypestring · enumoptionalAvailable options:

oauthUserInfostringoptional

securityPolicystringoptional

securityPolicyChangeinteger · int64optional

userTypeProprietaryInfoobjectoptional

Responses

application/json

post

POST /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
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

Modify a single user.

put

Authorizations

Path parameters

idinteger · int64required

Query parameters

email_verificationbooleanoptional

Body

idstring · uuidoptional

namestringoptional

descriptionstringoptional

avatarstring · urioptional

emailstring · emailoptional

validatedbooleanoptional

validationEmailstring · emailoptional

validationDateinteger · int64optional

createdinteger · int64optional

validationURIstringoptional

changePasswordbooleanoptional

lastLogininteger · int64optional

currentLoginURIstringoptional

lastPasswordChangeinteger · int64optional

lastEmailCheckinteger · int64optional

currentPasswordstringoptional

lastPasswordsstring[]optional

waitingForEmailCheckbooleanoptional

notesobject[]optional

locationstring · uuidoptional

ownerstring · uuidoptional

suspendedbooleanoptional

blackListedbooleanoptional

localestringoptional

userRolestring · enumoptionalAvailable options:

oauthTypestring · enumoptionalAvailable options:

oauthUserInfostringoptional

securityPolicystringoptional

securityPolicyChangeinteger · int64optional

userTypeProprietaryInfoobjectoptional

Responses

application/json

put

PUT /api/v1/user/{id} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
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

Create an avatar associated with a user ID.

post

Authorizations

Path parameters

idstring · uuidrequired

Body

string · binaryoptional

Responses

application/json

objectoptional

application/json

post

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
}

Send test email with the system.

post

Authorizations

Body

fromstring · emailoptional

subjectstringoptional

recipientsstring · email[]optional

textstringoptional

Responses

application/json

objectoptional

application/json

post

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
}

Send test email with the system.

post

Authorizations

Query parameters

validateNumberbooleanoptional

completeValidationbooleanoptional

validationCodestringoptional

Body

fromstringoptional

tostringoptional

textstringoptional

Responses

application/json

objectoptional

application/json

post

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
}

Perform some system wide commands.

post

Authorizations

Body

one ofoptional

Responses

application/json

one ofoptional

application/json

post

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"
    }
  ]
}