SecurityProvider
SecurityProvider
[GET] /api/v1/securityproviders
Get all the loaded security providers.
Response
Status Code: 200
Success
[GET] /api/v1/securityproviders/available
Get all the available security providers.
Response
Status Code: 200
Success
[PUT] /api/v1/securityproviders/{name}
Update the settings of the specified security provider.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path | The security provider name. |
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/v1/securityproviders/{name}
Remove the specified security provider.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path | The security provider name. |
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/enable
Enable or disable the specified security provider.
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/move
Update the priority of the specified security provider.
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/reload
Reload all the security providers.
Response
Status Code: 200
Success
[GET] /api/v1/securityproviders/export
Export all the security providers' settings.
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/import
Import the specified security providers.
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/testing
Test the specified security provider.
Request Schema
Response
Status Code: 200
Success
Models
Ƭ SecurityProviderModel
| Name | Type | Description | Example |
|---|---|---|---|
| providerNameNullable | string | ||
| descriptionNullable | string | ||
| ordinal | int32 | ||
| enabled | Boolean | ||
| settingsNullable | ConfigurationItem |
Ƭ ConfigurationItem
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | ||
| displayNameNullable | string | ||
| descriptionNullable | string | ||
| valueType | ConfigurationItemValueType | ||
| valueNullable | any | ||
| restriction | ConfigurationItemRestriction |
Ƭ ConfigurationItemValueType
Enum:
TextBooleanNumberPassword
Ƭ ConfigurationItemRestriction
Enum:
MandatoryOptional
Ƭ SecurityProviderEnableModel
| Name | Type | Description | Example |
|---|---|---|---|
| providerNamesNullable | Array<string> |
||
| enable | Boolean |
Ƭ SecurityProviderMoveModel
| Name | Type | Description | Example |
|---|---|---|---|
| providerNameNullable | string | ||
| offset | int32 |
Ƭ SecurityProvidersImportModel
| Name | Type | Description | Example |
|---|---|---|---|
| securityProvidersNullable | SecurityProviderModel |
Ƭ SecurityProviderTestingModel
| Name | Type | Description | Example |
|---|---|---|---|
| providerNameNullable | string | ||
| usernameNullable | string | ||
| passwordNullable | string | ||
| settingsNullable | ConfigurationItem | ||
| customParameterNullable | Array<string> |