logo
API docs by Redocly

Identity Server (1.0)

Download OpenAPI specification:Download

E-mail: connor.brezinsky@gmail.com

Identity server API

public

public endpoints not requiring authentication

Validate a user

verifies if the specifed jwt token is valid

Request Body schema: application/json
optional
token
string <JWT>

Responses

Request samples

Content type
application/json
{
  • "token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiMDJkZDVkY2ItYzA3My00ZWZhLWJjMDMtMTU3MTViYTUyNzQyIl0sImV4cCI6MTcxOTQ2NjAwNCwiaWF0IjoxNzE5NDY0MjA0LCJpc3MiOiJnbyIsIm5iZiI6MTU0NjMwMDgwMCwic3ViIjoiSm9obiBTbWl0aCJ9.LZBZlxsmPNXB2mHas_k8YYZgCWRxktRojys9LMkqy5wAhiMILujtn9fJ0t2Ia_RTNJ_VO-ghi_0QDotFG1zTguiG7chl-SFU0ZtdksSxcIpeToab89M0ZD29MYw8y1yz00YFuircUBExe_5EJSSbHIMhLbdCNPa4fisySFYdRKZr9c7wsENx-Ti-DxhGsvQyhCFl2rvFdiVmf5uY_cN8iYRe6JUIrJZQhZRIwokjpJwRPWS5fpd-fA3m7AbD3j3p9ItDMqzlZzT7zcPQJyODUcMZTKgDbwhXntS2O2XJkrXG6VfvNYwTHJ5Nq1jWnh7lKBfELpZKOuR2hQj3zt11KVD6sj17gru1vbjGYTmIagP47CPvPV9zrzg6MAMgT-CWYxVk6tFRePK-_Cz32nU_XrXA1jIuaF2yb6HOgdQg3RlQelYukm_FtJpA756VH1NabsrkgeRApIg-eTeeLVnNgQIi0n_nPir72x8gVuILiiegs7JD-s6h3Gevu9mj9A74pEtZOH2gCrFWIqkDcw7bT_2fbGPfQd8d3KjEsTSyndUxR64jxOnFKcvzmNFLfBh0s-oORX5UMeEbikbkUMIp0hJQLGdD6W0yaEJxo2MQUojFmuc6kGxWB3cIAWUXw2j6kEA18jcCzMwXiLOAXyepjKZZPAoM9yxtOHydmAzyUsI"
}

Register a user

registers a new user

Request Body schema: application/json
optional
name
string
email
string <email>
password
string
reset_password
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "John Smith",
  • "email": "john.smith@example.com",
  • "password": "testing1234",
  • "reset_password": false
}

Response samples

Content type
application/json
"User Registered"

Authenticate User

authenticates an existing user

Request Body schema: application/json
optional
email
string <email>
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@example.com",
  • "password": "testing1234"
}

Response samples

Content type
application/json
{
  • "uid": "02dd5dcb-c073-4efa-bc03-15715ba52742",
  • "name": "John Smith",
  • "email": "john.smith@example.com",
  • "active": true,
  • "reset_password": false,
  • "token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiMDJkZDVkY2ItYzA3My00ZWZhLWJjMDMtMTU3MTViYTUyNzQyIl0sImV4cCI6MTcxOTQ2NDkzNiwiaWF0IjoxNzE5NDYzMTM2LCJpc3MiOiJnbyIsIm5iZiI6MTU0NjMwMDgwMCwic3ViIjoiSm9obiBTbWl0aCJ9.gSi7ZAi3OqF-JMVhlKSzI1ckpAkaI535kEMrlXlJxdit5a6GjTQC7VpqIoCydWicrogdIQoGwXIHHyN_DEoozA0CZKGjEqu0LyFIPILpICo8HyVklx_G3cP_X_Kn2nPwPvTxI84b3S1m0zmV6vJUrQvF6pn1egBz36jQ-tEdIno3vDc1nYupXBim-YzPTSeGFx9Nn86NoAT9vHDZBi_RIks40_sH1e4l1d3E-3FP1VkAAPjx-AkUZuEFgbWatl9390SnX2Wsd8X9GRiQ9JAbiw2ySVFOZ1lvcEVbysqxP9Bp3mE2xBlwJdkG2ZFWSIHDbR3pkGChfgipRjGkI757q9isJuIAOu2OmJjulsd373STruNKmPb0R8JoB-mI2VdLl-8fdEEvb7_KNdJVePMd-h-RQcXL-ScJSXeF_uS5nXmgTmEKBXeNVANAhyAWTc-Mg1Ta5S6F0DRc7HAY2iiEHPackuWnafQVbly19uy0BQICKpsaLAQRw3LuOmtv-LCkrWwCzUZD7pIH_kD88iijywebxbOGer9OprV4_Qn-xBJNAHfCRKGT4ivR6bV8PFuOG7RVBZCCPtEugIp9vh_O8TVYgyoXAXRxyZy8iyyUjuayEB1HCBCOFIsuJ5K6E1SlUANpCqvaa8F4UkpWdVfew37siB9RYBNjdoYZbO-LM64"
}

Reset user password

resets a users password

Request Body schema: application/json
optional
user_uid
string <uuid>
old_password
string
new_password
string

Responses

Request samples

Content type
application/json
{
  • "user_uid": "02dd5dcb-c073-4efa-bc03-15715ba52742",
  • "old_password": "testing1234",
  • "new_password": "newtesting1234"
}

Response samples

Content type
application/json
"Error Registering"

Activate user

activates a pending user account

path Parameters
uid
required
string <uuid>

UUID of user that should be activated

code
required
string

one time code for the user that should be activated

Responses

Response samples

Content type
application/json
true

auth

Validate a user

verifies if the specifed jwt token is valid

Request Body schema: application/json
optional
token
string <JWT>

Responses

Request samples

Content type
application/json
{
  • "token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiMDJkZDVkY2ItYzA3My00ZWZhLWJjMDMtMTU3MTViYTUyNzQyIl0sImV4cCI6MTcxOTQ2NjAwNCwiaWF0IjoxNzE5NDY0MjA0LCJpc3MiOiJnbyIsIm5iZiI6MTU0NjMwMDgwMCwic3ViIjoiSm9obiBTbWl0aCJ9.LZBZlxsmPNXB2mHas_k8YYZgCWRxktRojys9LMkqy5wAhiMILujtn9fJ0t2Ia_RTNJ_VO-ghi_0QDotFG1zTguiG7chl-SFU0ZtdksSxcIpeToab89M0ZD29MYw8y1yz00YFuircUBExe_5EJSSbHIMhLbdCNPa4fisySFYdRKZr9c7wsENx-Ti-DxhGsvQyhCFl2rvFdiVmf5uY_cN8iYRe6JUIrJZQhZRIwokjpJwRPWS5fpd-fA3m7AbD3j3p9ItDMqzlZzT7zcPQJyODUcMZTKgDbwhXntS2O2XJkrXG6VfvNYwTHJ5Nq1jWnh7lKBfELpZKOuR2hQj3zt11KVD6sj17gru1vbjGYTmIagP47CPvPV9zrzg6MAMgT-CWYxVk6tFRePK-_Cz32nU_XrXA1jIuaF2yb6HOgdQg3RlQelYukm_FtJpA756VH1NabsrkgeRApIg-eTeeLVnNgQIi0n_nPir72x8gVuILiiegs7JD-s6h3Gevu9mj9A74pEtZOH2gCrFWIqkDcw7bT_2fbGPfQd8d3KjEsTSyndUxR64jxOnFKcvzmNFLfBh0s-oORX5UMeEbikbkUMIp0hJQLGdD6W0yaEJxo2MQUojFmuc6kGxWB3cIAWUXw2j6kEA18jcCzMwXiLOAXyepjKZZPAoM9yxtOHydmAzyUsI"
}

Authenticate User

authenticates an existing user

Request Body schema: application/json
optional
email
string <email>
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@example.com",
  • "password": "testing1234"
}

Response samples

Content type
application/json
{
  • "uid": "02dd5dcb-c073-4efa-bc03-15715ba52742",
  • "name": "John Smith",
  • "email": "john.smith@example.com",
  • "active": true,
  • "reset_password": false,
  • "token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiMDJkZDVkY2ItYzA3My00ZWZhLWJjMDMtMTU3MTViYTUyNzQyIl0sImV4cCI6MTcxOTQ2NDkzNiwiaWF0IjoxNzE5NDYzMTM2LCJpc3MiOiJnbyIsIm5iZiI6MTU0NjMwMDgwMCwic3ViIjoiSm9obiBTbWl0aCJ9.gSi7ZAi3OqF-JMVhlKSzI1ckpAkaI535kEMrlXlJxdit5a6GjTQC7VpqIoCydWicrogdIQoGwXIHHyN_DEoozA0CZKGjEqu0LyFIPILpICo8HyVklx_G3cP_X_Kn2nPwPvTxI84b3S1m0zmV6vJUrQvF6pn1egBz36jQ-tEdIno3vDc1nYupXBim-YzPTSeGFx9Nn86NoAT9vHDZBi_RIks40_sH1e4l1d3E-3FP1VkAAPjx-AkUZuEFgbWatl9390SnX2Wsd8X9GRiQ9JAbiw2ySVFOZ1lvcEVbysqxP9Bp3mE2xBlwJdkG2ZFWSIHDbR3pkGChfgipRjGkI757q9isJuIAOu2OmJjulsd373STruNKmPb0R8JoB-mI2VdLl-8fdEEvb7_KNdJVePMd-h-RQcXL-ScJSXeF_uS5nXmgTmEKBXeNVANAhyAWTc-Mg1Ta5S6F0DRc7HAY2iiEHPackuWnafQVbly19uy0BQICKpsaLAQRw3LuOmtv-LCkrWwCzUZD7pIH_kD88iijywebxbOGer9OprV4_Qn-xBJNAHfCRKGT4ivR6bV8PFuOG7RVBZCCPtEugIp9vh_O8TVYgyoXAXRxyZy8iyyUjuayEB1HCBCOFIsuJ5K6E1SlUANpCqvaa8F4UkpWdVfew37siB9RYBNjdoYZbO-LM64"
}

users

Find a user

gets the info of the specified user

path Parameters
uid
required
string <uuid>

UUID of user that should be fetched

Responses

Retrieve all users

Retrieves all users

Responses

Register a user

registers a new user

Request Body schema: application/json
optional
name
string
email
string <email>
password
string
reset_password
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "John Smith",
  • "email": "john.smith@example.com",
  • "password": "testing1234",
  • "reset_password": false
}

Response samples

Content type
application/json
"User Registered"

Reset user password

resets a users password

Request Body schema: application/json
optional
user_uid
string <uuid>
old_password
string
new_password
string

Responses

Request samples

Content type
application/json
{
  • "user_uid": "02dd5dcb-c073-4efa-bc03-15715ba52742",
  • "old_password": "testing1234",
  • "new_password": "newtesting1234"
}

Response samples

Content type
application/json
"Error Registering"

Activate user

activates a pending user account

path Parameters
uid
required
string <uuid>

UUID of user that should be activated

code
required
string

one time code for the user that should be activated

Responses

Response samples

Content type
application/json
true

permissions

Create a Permission

creates a new permission

Request Body schema: application/json
optional
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "example name",
  • "description": "example description"
}

Retrieve all permissions

Retrieves all permissions

Responses

Delete a permission

deletes the specified permission

path Parameters
id
required
integer <int64>

ID of permission that needs to be deleted

Responses

Find a permission

gets the info of the specified permission

path Parameters
id
required
integer <int64>

ID of permission that should be fetched

Responses

roles

/roles/create

creates a new role

Request Body schema: application/json
optional
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "example name",
  • "description": "example description"
}

Response samples

Content type
application/json
true

Add permission to role

adds a permission to an existing role

Request Body schema: application/json
optional
role_id
number
permission_id
number

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "permission_id": 0
}

Response samples

Content type
application/json
true

Delete role

deletes an existing role

path Parameters
id
required
string <uuid>

id of permission that should be deleted

Responses

Response samples

Content type
application/json
true

Find a role

gets the specified role info

path Parameters
id
required
string <uuid>

id of permission that should be added

Responses

Response samples

Content type
application/json
true

Grant role

grants a user an existing role

Request Body schema: application/json
optional
role_id
number
user_uid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "user_uid": "02dd5dcb-c073-4efa-bc03-15715ba52742"
}

Response samples

Content type
application/json
true

Remove permission from role

removes a permission from an existing role

Request Body schema: application/json
optional
role_id
number
permission_id
number

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "permission_id": 0
}

Response samples

Content type
application/json
true

Revoke role

revokes a role from a user

Request Body schema: application/json
optional
role_id
number
user_uid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "role_id": 0,
  • "user_uid": "02dd5dcb-c073-4efa-bc03-15715ba52742"
}

Response samples

Content type
application/json
true