API docs by Redocly

NovaFacies Open Source Project - Module 'Users' v1 (1.0.0)

Download OpenAPI specification:Download

NovaFacies Open Source Foundation: [email protected] URL: https://novafacies.org/ License: GNU GPLv3

API specification for Module 'Users' in NovaFacies Open Source Project. For more information, see https://novafacies.org

Creates a new user. Reference function with internal name: users.createUser

Creates a new user. Reference function with internal name: users.createUser

Authorizations:
BearerAuth
Request Body schema: application/json
first_name
required
string

See Module Description

middle_name
string

See Module Description

last_name
required
string

See Module Description

salutation
string

See Module Description

date_of_birth
string

See Module Description

email
required
string

See Module Description

address_name
required
string

See Module Description

street_address_1
required
string

See Module Description

street_address_2
string

See Module Description

city
required
string

See Module Description

state_region
required
string

See Module Description

postal_code
required
string

See Module Description

country
required
string

See Module Description

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "middle_name": "A.",
  • "last_name": "Doe",
  • "salutation": "Mr.",
  • "date_of_birth": "1990-01-01",
  • "email": "[email protected]",
  • "address_name": "Home",
  • "street_address_1": "123 Main St",
  • "street_address_2": "Apt 4B",
  • "city": "New York",
  • "state_region": "NY",
  • "postal_code": "10001",
  • "country": "US"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "user_id": "1234-abcd"
}

Retrieves details for an existing user. Reference function with internal name: users.getUser

Retrieves details for an existing user. Reference function with internal name: users.getUser

Authorizations:
BearerAuth
Request Body schema: application/json
user_id
required
string

See Module Description

Responses

Request samples

Content type
application/json
{
  • "user_id": "1234-abcd"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "user_id": "1234-abcd",
  • "first_name": "John",
  • "middle_name": "A.",
  • "last_name": "Doe",
  • "salutation": "Mr.",
  • "date_of_birth": "1990-01-01",
  • "email": "[email protected]",
  • "user_is_soft_deleted": false,
  • "user_is_permanently_deleted": false,
  • "address_id": "addr-5678",
  • "address_name": "Home",
  • "street_address_1": "123 Main St",
  • "street_address_2": "Apt 4B",
  • "city": "New York",
  • "state_region": "NY",
  • "postal_code": "10001",
  • "country": "US",
  • "address_is_soft_deleted": false,
  • "address_is_permanently_deleted": false
}

Retrieves UserID by querying unique fields. Reference function with internal name: users.getUserID

Retrieves UserID by querying unique fields. Reference function with internal name: users.getUserID

Authorizations:
BearerAuth
Request Body schema: application/json
email
required
string

See Module Description

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "success",
  • "user_id": "1234-abcd"
}

Updates user details. Reference function with internal name: users.updateUser

Updates user details. Reference function with internal name: users.updateUser

Authorizations:
BearerAuth
Request Body schema: application/json
user_id
required
string

See Module Description

first_name
string

See Module Description

middle_name
string

See Module Description

last_name
string

See Module Description

salutation
string

See Module Description

date_of_birth
string

See Module Description

email
string

See Module Description

address_id
string

See Module Description

address_name
string

See Module Description

street_address_1
string

See Module Description

street_address_2
string

See Module Description

city
string

See Module Description

state_region
string

See Module Description

postal_code
string

See Module Description

country
string

See Module Description

Responses

Request samples

Content type
application/json
{
  • "user_id": "1234-abcd",
  • "first_name": "John",
  • "middle_name": "A.",
  • "last_name": "Doe",
  • "salutation": "Mr.",
  • "date_of_birth": "1990-01-01",
  • "email": "[email protected]",
  • "address_id": "addr-5678",
  • "address_name": "Home",
  • "street_address_1": "123 Main St",
  • "street_address_2": "Apt 4B",
  • "city": "New York",
  • "state_region": "NY",
  • "postal_code": "10001",
  • "country": "US"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Permanently deletes a user. Reference function with internal name: users.deleteUser

Permanently deletes a user. Reference function with internal name: users.deleteUser

Authorizations:
BearerAuth
Request Body schema: application/json
user_id
required
string

See Module Description

Responses

Request samples

Content type
application/json
{
  • "user_id": "1234-abcd"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Soft deletes a user. Reference function with internal name: users.softDeleteUser

Soft deletes a user. Reference function with internal name: users.softDeleteUser

Authorizations:
BearerAuth
Request Body schema: application/json
user_id
required
string

See Module Description

Responses

Request samples

Content type
application/json
{
  • "user_id": "1234-abcd"
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Lists users with pagination. Reference function with internal name: users.listUsers

Lists users with pagination. Reference function with internal name: users.listUsers

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "users": [
    ],
  • "total": 100
}

Searches users by name, email, or other criteria. Reference function with internal name: users.searchUsers

Searches users by name, email, or other criteria. Reference function with internal name: users.searchUsers

Authorizations:
BearerAuth
Request Body schema: application/json
user_id
string

See Module Description

first_name
string

See Module Description

middle_name
string

See Module Description

last_name
string

See Module Description

salutation
string

See Module Description

date_of_birth
string

See Module Description

email
string

See Module Description

user_is_soft_deleted
boolean

See Module Description

user_is_permanently_deleted
boolean

See Module Description

address_id
string

See Module Description

address_name
string

See Module Description

street_address_1
string

See Module Description

street_address_2
string

See Module Description

city
string

See Module Description

state_region
string

See Module Description

postal_code
string

See Module Description

country
string

See Module Description

address_is_soft_deleted
boolean

See Module Description

address_is_permanently_deleted
boolean

See Module Description

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "success",
  • "results": [
    ]
}

Checks if a user exists by email. Reference function with internal name: users.validateUserExists

Checks if a user exists by email. Reference function with internal name: users.validateUserExists

Authorizations:
BearerAuth
Request Body schema: application/json
email
required
string

See Module Description

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "success",
  • "exists": true
}