Human Services Data API (HSDA) - Management v1.0

This is the OpenAPI definition for the Human Services Data API (HSDA) v1.2. This is a set of API paths, organized as a separate service, for managing access to any HSDA inmplementation. It is available as this HTML list or YAML OpenAPI definition, with an accompanying demo site, and link to current Github Issues for support.

Users
Get Users /users/ GET
Request Parameters:
query: A query to filter list by (up to provider to determine what to search)
queries: A comma separate list of queries with specific fields.
page: The particular page of results.
per_page: Number of records to return per page, up to 100.
sortby: Which field to sort by.
order: Which order to sort by (asc,desc).
Reponse Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Add User /users/ POST
Request Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Reponse Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Auth Users /users/auth/ GET
Request Parameters:
login: A users login
code: A uses code
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Get User /users/{user_id}/ GET
Path Parameters:
user_id: The user id.
Reponse Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Update User /users/{user_id}/ PUT
Path Parameters:
user_id: The user id.
Request Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Reponse Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Delete User /users/{user_id}/ DELETE
Path Parameters:
user_id: The user id.
Reponse Body:
id (string) Each entry must have a unique identifier.
login (string) The login for a user.
name (string) The name for a user.
email (string) The email for a user.
code (string) The unique code for user (Github Token)
Services
Get Services /services/ GET
Request Parameters:
query: A query to filter list by (up to provider to determine what to search)
queries: A comma separate list of queries with specific fields.
page: The particular page of results.
per_page: Number of records to return per page, up to 100.
sortby: Which field to sort by.
order: Which order to sort by (asc,desc).
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Add Service /services/ POST
Request Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Get Service /services/{service_id}/ GET
Path Parameters:
service_id: The service id.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Update Service /services/{service_id}/ PUT
Path Parameters:
service_id: The service id.
Request Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.
Delete Service /services/{service_id}/ DELETE
Path Parameters:
service_id: The service id.
Reponse Body:
id (string) Each entry must have a unique identifier.
user_id (string) The id for the user.
name (string) The name of the service the user has access to.
path (string) The path user has access to.
verb (string) The verb user has access to.