Client applications
API endpoints
Authentication: endpoints listed in this page require header authentication with an admin token.
Create a client application
POST
https://{domain}.biapi.pro/2.0/clients
Request body: ClientAppRequest object
Response body: ClientApp object
List client applications
GET
https://{domain}.biapi.pro/2.0/clients
Response body: ClientAppsList object
Get a client application
GET
https://{domain}.biapi.pro/2.0/clients/{clientAppId}
Get a single client application by ID.
Path Parameters
Name | Type | Description |
---|---|---|
clientAppId* | Integer | ID of the client application. |
Response body: ClientApp object
Update a client application
PUT
https://{domain}.biapi.pro/2.0/clients/{clientAppId}
Update a single client application by ID.
Request body: ClientAppUpdateRequest object
Path Parameters
Name | Type | Description |
---|---|---|
clientAppId* | Integer | ID of the client application. |
Response body: ClientApp object
Delete a client application
DELETE
https://{domain}.biapi.pro/2.0/clients/{clientAppId}
Delete a client application by ID.
Path Parameters
Name | Type | Description |
---|---|---|
clientAppId* | Integer | ID of the client application. |
Update the logo of a client application
POST
https://{domain}.biapi.pro/2.0/clients/{clientAppId}/logo
Path Parameters
Name | Type | Description |
---|---|---|
clientAppId* | Integer | ID of the client application. |
Data model
ClientAppRequest object
Property | Type | Required | Description |
---|---|---|---|
| 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. |
| String | No | Name of the client app. |
| String | No | List of allowed redirect URIs. |
| String | No | Custom config about the client. |
ClientAppsList object
Property | Type | Description |
---|---|---|
| Array of ClientApp objects | The client applications. |
ClientApp object
Property | Type | Description |
---|---|---|
| Integer | ID of the client. |
| String | Name of the client application. |
| String or null | The client secret is only exposed if you use a manage or configuration token. |
| String or null | |
| String or null | |
| String | |
| Integer or null | |
| String | Customizable config. |
ClientAppUpdateRequest object
Property | Type | Required | Description |
---|---|---|---|
| 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. |
| String | No | New name of the client app. |
| String | No | Reset the secret of the client. |
| String | No | New list of allowed redirect URIs. |
| String | No | Hexadecimal code of the client primary color |
| No | Custom config about the client | |
| Boolean | No | Merge the provided |
Last updated