- 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
ExternalLoginProvider
ExternalLoginProvider
[GET] /api/v1/externalloginproviders
Get all external login providers.
Response
Status Code: 200
Success
[PUT] /api/v1/externalloginproviders/{name}
Update the specified external login provider's information.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path | The name of the specified external login provider. |
Request Schema
Response
Status Code: 200
Success
[POST] /api/v1/externalloginproviders/{name}/sync
Syncing the specified external login provider's users, roles, and organizations.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/v1/externalloginproviders/{name}/tenants
Get the specified external login provider's tenants.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/v1/externalloginproviders/{name}/organizations
Get the specified external login provider's tenants.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/v1/externalloginproviders/{name}/roles
Get the specified external login provider's roles.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/v1/externalloginproviders/{name}/users
Get the specified external login provider's users.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/v1/externalloginproviders/message-enabled
Get all the external login providers which enables sending messages.
Response
Status Code: 200
Success
[POST] /api/v1/externalloginproviders/{name}/message
Send message to specified external login provider.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| nameRequired | string | path |
Request Schema
Response
Status Code: 200
Success
Models
Ƭ ExternalLoginProviderModel
| Name | Type | Description | Example |
|---|---|---|---|
| providerNameNullable | string | ||
| descriptionNullable | string | ||
| dataSyncingTimeNullable | ISO DateTime Sting | ||
| 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
Ƭ ExternalMessage
| Name | Type | Description | Example |
|---|---|---|---|
| subjectNullable | string | ||
| recipients | MessageRecipients | ||
| contentNullable | string | ||
| urlNullable | string |
Ƭ MessageRecipients
| Name | Type | Description | Example |
|---|---|---|---|
| usersNullable | Array<string> |
||
| organizationsNullable | Array<string> |
||
| rolesNullable | Array<string> |
||
| allUsers | Boolean |