- V2
-
V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
-
SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
SecurityProvider
SecurityProvider
[GET] /api/v1/securityproviders
Get all security providers.
Response
Status Code: 200
Success
[GET] /api/v1/securityproviders/available
Get enabled security providers.
Response
Status Code: 200
Success
[PUT] /api/v1/securityproviders/{name}
Update the specified security provider's settings.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/v1/securityproviders/{name}
Delete the specified security provider.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/enable
Enable the specified security provider.
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/move
Update the ordinal of the specified security provider.
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/reload
Reload all security providers.
Response
Status Code: 200
Success
[GET] /api/v1/securityproviders/export
Export security providers.
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/import
Import security providers.
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/securityproviders/testing
Testing the specified security provider's settings.
Request Schema
Response
Status Code: 200
Success
Models
Ƭ SecurityProviderModel
| Name | Type | Description | Example |
|---|---|---|---|
| providerNameNullable | string | The name of the security provider. | "AD Security Provider" |
| descriptionNullable | string | The description text of the security provider. | "The built-in AD security provider." |
| ordinal | int32 | The ordinal of the security provider. | 1 |
| enabled | Boolean | Whether the security provider is enabled. | true |
| settingsNullable | ConfigurationItem | The configuration items. |
Ƭ 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> |