GET
/v1/mgmt/widgetAuthorization
Descope Project ID and Management Key AuthorizationBearer <token>
Project ID:Management Key as bearer token.
In: header
Query Parameters
id*string
Get a single widget by id in its exported representation, using a valid management key.
curl -X GET "https://api.descope.com/v1/mgmt/widget?id=string"{ "widgetId": "string", "metadata": { "name": "string", "description": "string", "type": "string", "components": [ "string" ], "columns": [ "string" ], "flowsIds": [ "string" ], "allowSubTenants": true, "eventActions": [ "string" ], "editMultiTenantUsers": true, "forAppUsers": true, "forTenantUsers": true, "eventExcludeFields": [ "string" ], "eventFilter": [ { "key": "string", "value": [ "string" ], "operator": "string", "type": "string", "valueStr": "string" } ], "translation": { "enabled": true, "connectorId": "string", "sourceLanguage": "string", "targetLanguages": [ "string" ] }, "requiredPermissions": [ "string" ], "ssoAppIds": [ "string" ], "flowTarget": "string" }, "screens": [ { "screenId": "string", "interactions": [ { "id": "string", "type": "string", "label": "string", "icon": "string", "subType": "string" } ], "contents": {}, "componentsConditions": { "values": [ null ] } } ], "flows": [ { "flowId": "string", "metadata": { "name": "string", "description": "string", "componentsVersion": "string", "disabled": true, "fingerprint": true, "widget": true, "translation": { "enabled": true, "connectorId": "string", "sourceLanguage": "string", "targetLanguages": [ "string" ] }, "sharedInteractions": [ { "id": "string", "type": "string", "label": "string", "icon": "string", "subType": "string" } ], "management": true, "managementConfig": { "triggers": { "enabled": true, "triggerType": "string", "eventTriggers": { "triggeringEventTypes": [ "string" ] } } }, "clientValidationTracking": true }, "contents": {}, "screens": [ { "screenId": "string", "interactions": [ { "id": "string", "type": "string", "label": "string", "icon": "string", "subType": "string" } ], "contents": {} } ], "references": { "connectors": { "property1": "string", "property2": "string" }, "oauth": [ "string" ], "omitted": [ "string" ], "roles": { "property1": "string", "property2": "string" }, "userAttributes": [ "string" ], "tenantAttributes": [ "string" ] } } ]}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface Response {widgetId: stringmetadata: ExportedWidgetMetadatascreens?: ExportedWidgetScreen[]flows?: ExportedFlow[]}export interface ExportedWidgetMetadata {name: stringdescription?: stringtype?: stringcomponents?: string[]columns?: string[]flowsIds?: string[]allowSubTenants?: booleaneventActions?: string[]editMultiTenantUsers?: booleanforAppUsers?: booleanforTenantUsers?: booleaneventExcludeFields?: string[]eventFilter?: FilterCondition[]translation?: ExportedWidgetTranslationrequiredPermissions?: string[]ssoAppIds?: string[]flowTarget?: string}export interface FilterCondition {key?: stringvalue?: string[]operator?: stringtype?: stringvalueStr?: string}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface ExportedWidgetTranslation {enabled?: booleanconnectorId?: stringsourceLanguage?: stringtargetLanguages?: string[]}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface ExportedWidgetScreen {screenId: stringinteractions?: {id?: stringtype?: stringlabel?: stringicon?: stringsubType?: string}[]contents: {}/** * The screen's component conditions (hide/disable/read-only rules), in the same JSON shape * flows use. A list rather than the bytes WidgetScreen uses, so the exported file stays * readable and diffable. */componentsConditions?: GoogleProtobuf}/** * `ListValue` is a wrapper around a repeated field of values. * * The JSON representation for `ListValue` is JSON array. */export interface GoogleProtobuf {/** * Repeated field of dynamically typed values. */values?: {[k: string]: unknown}[]}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface ExportedFlow {flowId: stringmetadata: ExportedFlowMetadatacontents: {}screens?: ExportedScreen[]/** * Used by managementservice snapshots - make sure not to break compatibility */references?: {connectors?: {[k: string]: string}oauth?: string[]omitted?: string[]roles?: {[k: string]: string}userAttributes?: string[]tenantAttributes?: string[]}}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface ExportedFlowMetadata {name: stringdescription?: stringcomponentsVersion?: stringdisabled?: booleanfingerprint?: booleanwidget?: booleantranslation?: ExportedFlowTranslationsharedInteractions?: {id?: stringtype?: stringlabel?: stringicon?: stringsubType?: string}[]management?: booleanmanagementConfig?: {triggers?: ManagementConfigTriggers}clientValidationTracking?: boolean}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface ExportedFlowTranslation {enabled?: booleanconnectorId?: stringsourceLanguage?: stringtargetLanguages?: string[]}export interface ManagementConfigTriggers {enabled?: booleantriggerType?: stringeventTriggers?: ManagementConfigEventTriggers}export interface ManagementConfigEventTriggers {triggeringEventTypes?: string[]}/** * Used by managementservice snapshots - make sure not to break compatibility */export interface ExportedScreen {screenId?: stringinteractions?: {id?: stringtype?: stringlabel?: stringicon?: stringsubType?: string}[]contents?: {}} Was this helpful?
Get Tenant Theme GET
Get the styles a tenant overrides the project theme with, using a valid management key. The logo is returned as a base64 data URI, so the response can be sent back to Set Tenant Theme unchanged. Returns 404 when the tenant has no theme of its own, in which case flows for that tenant render with the project theme.
Set flow POST
Create or update a single flow from its exported representation, remapping any connector and role references to matching entities in the project, using a valid management key.