Voice Biometrics User Groups

This describes the web services that manage voice biometric user groups.

Authorisation

The format for the username and password is as follows:

For example:

$ curl --user 1-2-0/bob@example.com:WzyPvLMYBUMvFOgXj3S7fg https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/list

Date formats

All dates are of the format YYYY-MM-DD_hh:mm:ss and are in Coordinated Universal Time (UTC).

Response content

All web services in this API return response content of type "application/json".

• List
• Create
• Delete

• List

  List the user groups.

  Url	:	https://ws.aculabcloud.net/voice_biometrics/v1/user_group/list
  Methods	:	GET, POST

  Parameter	Required/Optional	Default	Description
  user_group_name	optional		the name of a user group.

  Returns on success:

  A JSON object containing a list of user group objects containing the following parameters:

  Parameter	Type	Availability	Description
  name	string	always	the name of the user group.
  created	string	always	the creation date and time of the user group.
  registrations	integer	always	the number of registrations currently on the user group.

  Example:

  https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/list

  If successful you will receive the JSON response:

  {
  	"user_groups": [
  		{
  			"name": BobsCompany",
  			"created": "2021-01-15_08:56:24",
  			"registrations": 7
  		},
  		{
  			"name": "BillsCompany",
  			"created": "2020-12-09_15:22:14",
  			"registrations": 14
  		}
  	]
  }

• Create

  This creates a user group.

  Url	:	https://ws.aculabcloud.net/voice_biometrics/v1/user_group/create
  Methods	:	GET, POST

  Parameter	Required/Optional	Default	Description
  user_group_name	required		the name of the user group to create. The maximum length is 64 characters. Multiple consecutive spaces, and characters " ^ : are not supported.

  Returns on success:

  A JSON object containing the following parameters:

  Parameter	Type	Availability	Description
  created	string	always	the creation date and time of the user group.

  Example:

  https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/create?user_group_name=BobsCompany

  If successful you will receive the JSON response:

  {
  	"created": "2021-01-15_08:56:24"
  }

  Or on error the JSON response:

  {
  	"error": {
  		"code": HTTP 403,
  		"text": "Forbidden: user group BobsCompany is already present", 
  		"link": "https://www.aculab.com/cloud/web-services/voice-biometrics/user_groups?target=service_action_tabs&tab-id=create",
  		"datetime": "2021-01-15_08:56:24"
  	},
  	"request": {
  		"url": "/voice_biometrics/v1/user_group/create",
  		"datetime": "2021-01-15_08:56:23"
  	}
  }

• Delete

  This deletes a user group.

  Url	:	https://ws.aculabcloud.net/voice_biometrics/v1/user_group/delete
  Methods	:	GET, POST

  Parameter	Required/Optional	Default	Description
  user_group_name	required		the name of the user group to delete.

  Returns on success:

  A JSON object containing the following parameters:

  Parameter	Type	Availability	Description
  deleted	string	always	the deletion date and time of the user group.

  Example:

  https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/delete?user_group_name=BobsCompany

  If successful you will receive the JSON response:

  {
  	"deleted": "2021-01-15_08:56:24"
  }

  Or on error the JSON response:

  {
  	"error": {
  		"code": HTTP 404,
  		"text": "Not found: user group BobsCompany was not found", 
  		"link": "https://www.aculab.com/cloud/web-services/voice-biometrics/user_groups?target=service_action_tabs&tab-id=delete",
  		"datetime": "2021-01-15_08:57:14"
  	},
  	"request": {
  		"url": "/voice_biometrics/v1/user_group/delete",
  		"datetime": "2021-01-15_08:57:13"
  	}
  }