HSDA Management

The HSDA management protocol is defined by openapi-hsda-management.yaml. The details below show the available methods and responses.

This is a HSDA service specifically intended to assist in managing HSDA access, allowing users to get at resources made available any HSDA implementation. Providing the ability to manage users, and the HSDA services they have access to.

Note: services in this context refers to 'web services', not to 'human services'.

You can also explore this using our OpenAPI viewer.

Warning

This is an experimental feature. Feedback is welcome to shape its further development.

GET /users/

Get Users

Get Users

Query Parameters:
 
  • query (string) -- A query to filter list by (up to provider to determine what to search)
  • queries (string) -- A comma separate list of queries with specific fields.
  • page (number) -- The particular page of results.
  • per_page (number) -- Number of records to return per page, up to 100.
  • sortby (string) -- Which field to sort by.
  • order (string) -- Which order to sort by (asc,desc).
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
login
  The login for a user. string True
name
  The name for a user. string True
email
  The email for a user. string True
code
  The unique code for user (Github Token) string True
POST /users/

Add User

Add User

Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
login
  The login for a user. string True
name
  The name for a user. string True
email
  The email for a user. string True
code
  The unique code for user (Github Token) string True
GET /users/auth/

Auth Users

Auth Users

Query Parameters:
 
  • login (string) -- A users login
  • code (string) -- A uses code
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
name
  The name of the service the user has access to. string False
path
  The path user has access to. string True
verb
  The verb user has access to. string True
GET /users/{user_id}/

Get User

Get User

Parameters:
  • user_id (string) -- The user id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
login
  The login for a user. string True
name
  The name for a user. string True
email
  The email for a user. string True
code
  The unique code for user (Github Token) string True
PUT /users/{user_id}/

Update User

Update an existing user.

Parameters:
  • user_id (string) -- The user id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
login
  The login for a user. string True
name
  The name for a user. string True
email
  The email for a user. string True
code
  The unique code for user (Github Token) string True
DELETE /users/{user_id}/

Delete User

Delete User

Parameters:
  • user_id (string) -- The user id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
login
  The login for a user. string True
name
  The name for a user. string True
email
  The email for a user. string True
code
  The unique code for user (Github Token) string True
GET /services/

Get Services

Get Services

Query Parameters:
 
  • query (string) -- A query to filter list by (up to provider to determine what to search)
  • queries (string) -- A comma separate list of queries with specific fields.
  • page (number) -- The particular page of results.
  • per_page (number) -- Number of records to return per page, up to 100.
  • sortby (string) -- Which field to sort by.
  • order (string) -- Which order to sort by (asc,desc).
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
name
  The name of the service the user has access to. string False
path
  The path user has access to. string True
verb
  The verb user has access to. string True
POST /services/

Add Service

Add Service

Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
name
  The name of the service the user has access to. string False
path
  The path user has access to. string True
verb
  The verb user has access to. string True
GET /services/{service_id}/

Get Service

Get Service

Parameters:
  • service_id (string) -- The service id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
name
  The name of the service the user has access to. string False
path
  The path user has access to. string True
verb
  The verb user has access to. string True
PUT /services/{service_id}/

Update Service

Update an existing service.

Parameters:
  • service_id (string) -- The service id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
name
  The name of the service the user has access to. string False
path
  The path user has access to. string True
verb
  The verb user has access to. string True
DELETE /services/{service_id}/

Delete Service

Delete Service

Parameters:
  • service_id (string) -- The service id.
Status Codes:

200 Response Body:

  Description Type Required
id
  Each entry must have a unique identifier. string True
user_id
  The id for the user. string True
name
  The name of the service the user has access to. string False
path
  The path user has access to. string True
verb
  The verb user has access to. string True