Classes
Methods
# async create(client) → {Promise.<ClientApplication>}
Registers a new client application.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
ClientCreateModel
|
The client application is required for the OAuth flow. |
Promise.<ClientApplication>
# async delete(clientId) → {Promise.<void>}
Deletes the specified client application.
Parameters:
| Name | Type | Description |
|---|---|---|
clientId |
String
|
The id of the client application. |
Promise.<void>
# async generateApiKey(clientId) → {Promise.<String>}
Generates an API key for the specified client application. Requires an API user.
Parameters:
| Name | Type | Description |
|---|---|---|
clientId |
String
|
The id of the client application. |
Promise.<String>
# async generateSecret(clientId) → {Promise.<String>}
Generates a new secret for the specified client application.
Parameters:
| Name | Type | Description |
|---|---|---|
clientId |
String
|
The id of the client application. |
Promise.<String>
# async get(clientId) → {Promise.<ClientApplication>}
Returns the client application with the specified id.
Parameters:
| Name | Type | Description |
|---|---|---|
clientId |
String
|
The id of the client application. |
Promise.<ClientApplication>
# async list(optionsopt) → {Promise.<Array.<ClientApplication>>}
Returns all client applications.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
ListOptions
|
<optional> |
Pagination and filtering options |
Promise.<Array.<ClientApplication>>
# async update(clientId, client) → {Promise.<ClientApplication>}
Parameters:
| Name | Type | Description |
|---|---|---|
clientId |
String
|
The id of the client application. |
client |
ClientUpdateModel
|
The client application is required for the OAuth flow. |
Promise.<ClientApplication>