Security Service

PreviousOpenAPI Definitions NextGateway Service

Last updated 3 years ago

Was this helpful?

Retrieve the system layout.

get

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

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

cURL

JavaScript

Python

HTTP

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

200

403

404

No Content

Retrieve the information for a single user.

get

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 Content

Delete a single user.

delete

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

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

binary

Successfully retrieved the avatar

Remove an avatar associated with a user ID.

delete

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.

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

cURL

JavaScript

Python

HTTP

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

200

403

404

No Content

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

get

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 Content

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

get

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 Content

Retrieve different values from the running service.

get

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

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

Revoke a token.

delete

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 Content

successful operation

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

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

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

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": "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"
      }
    }
  }'

200

403

404

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

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": "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"
      }
    }
  }'

200

403

404

No Content

Create an avatar associated with a user ID.

post

Authorizations

Path parameters

idstring · uuidrequired

Body

string · binaryoptional

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 '"binary"'

200

403

404

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

The requested operation was performed.

Send test email with the system.

post

Authorizations

Body

fromstring · emailoptional

subjectstringoptional

recipientsstring · email[]optional

textstringoptional

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": "name@gmail.com",
    "subject": "text",
    "recipients": [
      "name@gmail.com"
    ],
    "text": "text"
  }'

200

403

404

500

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

The requested operation was performed.

Send test email with the system.

post

Authorizations

Query parameters

validateNumberbooleanoptional

completeValidationbooleanoptional

validationCodestringoptional

Body

fromstringoptional

tostringoptional

textstringoptional

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.

Perform some system wide commands.

post

Authorizations

Body

one ofoptional

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

Retrieve the system layout.

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

Retrieve the information for a single user.

Delete a single user.

Retrieve the avatar associated with a user ID.

Remove an avatar associated with a user ID.

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

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

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

Retrieve different values from the running service.

Revoke a token.

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

Show child attributes

Show child attributes

Create a single user.

Show child attributes

Show child attributes

Modify a single user.

Show child attributes

Show child attributes

Create an avatar associated with a user ID.

Send test email with the system.

Send test email with the system.

Perform some system wide commands.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes