Security Service

PreviousOpenAPI Definitions NextGateway Service

Last updated 2 years ago

Was this helpful?

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

post

/oauth2

Authorizations

Query parameters

newPasswordstring

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

forgotPasswordboolean

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

requirementsboolean

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

resendMFACodeboolean

completeMFAChallengeboolean

Body

one of

User Id and password.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/oauth2' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "support@example.com",
    "password": "support"
  }'

200

403

404

{
  "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

Revoke a token.

delete

/oauth2/{token}

Authorizations

Path parameters

tokenstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/oauth2/{token}' \
  --header 'Authorization: Bearer JWT'

204

403

404

No body

successful operation

Retrieve the system layout.

get

/systemEndpoints

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/systemEndpoints' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "endpoints": [
    {
      "type": "text",
      "id": 1,
      "vendor": "text",
      "uri": "https://example.com",
      "authenticationType": "text"
    }
  ]
}

successful operation

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

get

/users

Authorizations

Query parameters

offsetinteger · int64

limitinteger · int64

filterstring

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

idOnlyboolean

Return only the ids.

selectstring

Return only the ids.

Example: id1,id2,id3,id4,id5

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/users' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Retrieve the information for a single user.

get

/user/{id}

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/user/{id}' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Create a single user.

post

/user/{id}

Authorizations

Path parameters

idinteger · int64required

Query parameters

email_verificationboolean

Body

idstring · uuid

namestring

descriptionstring

avatarstring · uri

emailstring · email

validatedboolean

validationEmailstring · email

validationDateinteger · int64

createdinteger · int64

validationURIstring

changePasswordboolean

lastLogininteger · int64

currentLoginURIstring

lastPasswordChangeinteger · int64

lastEmailCheckinteger · int64

currentPasswordstring

waitingForEmailCheckboolean

locationstring · uuid

ownerstring · uuid

suspendedboolean

blackListedboolean

localestring

oauthUserInfostring

securityPolicystring

securityPolicyChangeinteger · int64

userTypeProprietaryInfoobject

userRolestring · enum

Options: root, admin, subscriber, csr, system, installer, noc, accounting

oauthTypestring · enum

Options: internal, normal, gmail, facebook, linkedin, instagram

lastPasswordsstring[]

notesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/user/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "avatar": "https://example.com",
    "email": "hello@example.com",
    "validated": true,
    "validationEmail": "hello@example.com",
    "validationDate": 1,
    "created": 1,
    "validationURI": "text",
    "changePassword": true,
    "lastLogin": 1,
    "currentLoginURI": "text",
    "lastPasswordChange": 1,
    "lastEmailCheck": 1,
    "currentPassword": "text",
    "waitingForEmailCheck": true,
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "owner": "123e4567-e89b-12d3-a456-426614174000",
    "suspended": true,
    "blackListed": true,
    "locale": "text",
    "oauthUserInfo": "text",
    "securityPolicy": "text",
    "securityPolicyChange": 1,
    "userTypeProprietaryInfo": {
      "mfa": {
        "enabled": true,
        "method": "sms"
      },
      "mobiles": [
        {
          "number": "text",
          "verified": true,
          "primary": true
        }
      ]
    },
    "userRole": "root",
    "oauthType": "internal",
    "lastPasswords": [
      "text"
    ],
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ]
  }'

200

403

404

No body

Modify a single user.

put

/user/{id}

Authorizations

Path parameters

idinteger · int64required

Query parameters

email_verificationboolean

Body

idstring · uuid

namestring

descriptionstring

avatarstring · uri

emailstring · email

validatedboolean

validationEmailstring · email

validationDateinteger · int64

createdinteger · int64

validationURIstring

changePasswordboolean

lastLogininteger · int64

currentLoginURIstring

lastPasswordChangeinteger · int64

lastEmailCheckinteger · int64

currentPasswordstring

waitingForEmailCheckboolean

locationstring · uuid

ownerstring · uuid

suspendedboolean

blackListedboolean

localestring

oauthUserInfostring

securityPolicystring

securityPolicyChangeinteger · int64

userTypeProprietaryInfoobject

userRolestring · enum

Options: root, admin, subscriber, csr, system, installer, noc, accounting

oauthTypestring · enum

Options: internal, normal, gmail, facebook, linkedin, instagram

lastPasswordsstring[]

notesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16001/api/v1/user/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "avatar": "https://example.com",
    "email": "hello@example.com",
    "validated": true,
    "validationEmail": "hello@example.com",
    "validationDate": 1,
    "created": 1,
    "validationURI": "text",
    "changePassword": true,
    "lastLogin": 1,
    "currentLoginURI": "text",
    "lastPasswordChange": 1,
    "lastEmailCheck": 1,
    "currentPassword": "text",
    "waitingForEmailCheck": true,
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "owner": "123e4567-e89b-12d3-a456-426614174000",
    "suspended": true,
    "blackListed": true,
    "locale": "text",
    "oauthUserInfo": "text",
    "securityPolicy": "text",
    "securityPolicyChange": 1,
    "userTypeProprietaryInfo": {
      "mfa": {
        "enabled": true,
        "method": "sms"
      },
      "mobiles": [
        {
          "number": "text",
          "verified": true,
          "primary": true
        }
      ]
    },
    "userRole": "root",
    "oauthType": "internal",
    "lastPasswords": [
      "text"
    ],
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ]
  }'

200

403

404

No body

Delete a single user.

delete

/user/{id}

Authorizations

Path parameters

idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/user/{id}' \
  --header 'Authorization: Bearer JWT'

204

403

404

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

The requested operation was performed.

Retrieve the avatar associated with a user ID.

get

/avatar/{id}

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/avatar/{id}' \
  --header 'Authorization: Bearer JWT'

200

403

404

image/jpeg

image/png

image/svg+xml

text

Successfully retrieved the avatar

Create an avatar associated with a user ID.

post

/avatar/{id}

Authorizations

Path parameters

idstring · uuidrequired

Body

string · binary

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/avatar/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: image/jpeg' \
  --data '"text"'

200

403

404

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

The requested operation was performed.

Remove an avatar associated with a user ID.

delete

/avatar/{id}

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16001/api/v1/avatar/{id}' \
  --header 'Authorization: Bearer JWT'

204

403

404

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

The requested operation was performed.

Send test email with the system.

post

/email

Authorizations

Body

fromstring · email

subjectstring

textstring

recipientsstring · email[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/email' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "from": "hello@example.com",
    "subject": "text",
    "text": "text",
    "recipients": [
      "hello@example.com"
    ]
  }'

200

403

404

500

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

The requested operation was performed.

Send test email with the system.

post

/sms

Authorizations

Query parameters

validateNumberboolean

completeValidationboolean

validationCodestring

Body

fromstring

tostring

textstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/sms' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "from": "text",
    "to": "text",
    "text": "text"
  }'

200

403

404

500

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

The requested operation was performed.

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

get

/securityProfiles

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

filterstring

Filter the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/securityProfiles' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

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

get

/systemServices

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/systemServices' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

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

get

/validateToken

Authorizations

Query parameters

tokenstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/validateToken?token=text' \
  --header 'Authorization: Bearer JWT'

200

403

404

No body

Retrieve different values from the running service.

get

/system

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Options: info

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16001/api/v1/system?command=info' \
  --header 'Authorization: Bearer JWT'

200

403

404

{
  "version": "text",
  "uptime": 1,
  "start": 1,
  "os": "text",
  "processors": 1,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 1
    }
  ]
}

Successful command execution

Perform some system wide commands.

post

/system

Authorizations

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16001/api/v1/system' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "command": "setloglevel",
    "subsystems": [
      {
        "tag": "text",
        "value": "text"
      }
    ]
  }'

200

403

404

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}

Successful command execution