Client applications

API endpoints
Authentication: endpoints listed in this page require header authentication with an admin token.
post
https://{domain}.biapi.pro/2.0
/clients
Create a client application
get
https://{domain}.biapi.pro/2.0
/clients
List client applications
get
https://{domain}.biapi.pro/2.0
/clients/{clientAppId}
Get a client application
put
https://{domain}.biapi.pro/2.0
/clients/{clientAppId}
Update a client application
delete
https://{domain}.biapi.pro/2.0
/clients/{clientAppId}
Delete a client application
post
https://{domain}.biapi.pro/2.0
/clients/{clientAppId}/logo
Update the logo of a client application
Data model
ClientAppRequest object
Property
Type
Required
Description
generate_keys
Boolean
No
If true, generate a RSA pair of keys so the client can be used to generate JWT user tokens. The default is false.
name
String
No
Name of the client app.
redirect_uris
String
No
List of allowed redirect URIs.
config
String
No
Custom config about the client.
ClientAppsList object
Property
Type
Description
clients
Array of ClientApp objects
The client applications.
ClientApp object
Property
Type
Description
id
Integer
ID of the client.
name
String
Name of the client application.
secret
String or null
The client secret is only exposed if you use a manage or configuration token.
public_key
String or null
​
private_key
String or null
​
redirect_uris
String
​
id_logo
Integer or null
​
config
String
Customizable config.
ClientAppUpdateRequest object
Property
Type
Required
Description
generate_keys
Boolean
No
If true, generate a RSA pair of keys so the client can be used to generate JWT user tokens. The key has no effect if the client already has a set of keys. The default is false.
name
String
No
New name of the client app.
secret
String
No
Reset the secret of the client.
redirect_uris
String
No
New list of allowed redirect URIs.
primary_color
String
No
Hexadecimal code of the client primary color
config
​
No
Custom config about the client
update_config
Boolean
No
Merge the provided config with the existing one instead of replacing. The default is true.

Property	Type	Required	Description
`generate_keys`	Boolean	No	If true, generate a RSA pair of keys so the client can be used to generate JWT user tokens. The default is false.
`name`	String	No	Name of the client app.
`redirect_uris`	String	No	List of allowed redirect URIs.
`config`	String	No	Custom config about the client.

Property	Type	Description
`clients`	Array of ClientApp objects	The client applications.

Property	Type	Description
`id`	Integer	ID of the client.
`name`	String	Name of the client application.
`secret`	String or null	The client secret is only exposed if you use a manage or configuration token.
`public_key`	String or null
`private_key`	String or null
`redirect_uris`	String
`id_logo`	Integer or null
`config`	String	Customizable config.

Property	Type	Required	Description
`generate_keys`	Boolean	No	If true, generate a RSA pair of keys so the client can be used to generate JWT user tokens. The key has no effect if the client already has a set of keys. The default is false.
`name`	String	No	New name of the client app.
`secret`	String	No	Reset the secret of the client.
`redirect_uris`	String	No	New list of allowed redirect URIs.
`primary_color`	String	No	Hexadecimal code of the client primary color
`config`		No	Custom config about the client
`update_config`	Boolean	No	Merge the provided `config` with the existing one instead of replacing. The default is true.

API SETUP - Previous

Configuration

Last modified 1mo ago