Genereret ved build

Reference

Genereret fra gateway’ens OpenAPI-dokument ved hvert build. Ret ikke i den her: ret beskrivelsen i ruten.

Feltbeskrivelser, skemaer og fejlkoder står i dokumentet selv: /v1/openapi.json. En håndskrevet reference holder op med at være sand ved den første ændring.

Åbn SwaggerInteraktiv flade, udstillet af API'et selv, så kald kan prøves med jeres egen nøgle.

122 ruter, genereret ved build.

GET/accesseslist_accesses

List the accesses in this workspace.

POST/accessesgrant_access

Grant a person access to a portal, sending the invitation.

DELETE/accesses/{accessId}revoke_access

Revoke an access. Soft: the row is kept for the audit trail.

GET/accesses/{accessId}get_access

Read one access.

PATCH/accesses/{accessId}update_access

Change an access's organization, roles, groups or suspend it.

PUT/accesses/{accessId}/data-scopessave_access_data_scopes

Narrow what this access may see, beyond its roles.

GET/accesses/{accessId}/diagnosticsget_access_diagnostics

What will this person actually see, app by app, and why not?

POST/accesses/{accessId}/impersonatestart_impersonation

Open the portal as this person, to see exactly what they see.

POST/accesses/{accessId}/resend-inviteresend_access_invite

Send the invitation again, reviving a revoked or suspended access.

GET/address-appslist_address_apps

The apps this workspace has defined from an address.

POST/address-appscreate_address_app

Define an app whose content is a page from a tool you already use.

DELETE/address-apps/{appKey}delete_address_app

Delete an address app, its addresses and its placements.

GET/address-apps/{appKey}get_address_app

Read one address app.

PATCH/address-apps/{appKey}update_address_app

Change an address app's name, icon or frame.

DELETE/address-apps/{appKey}/addresses/{organizationId}clear_organization_address

Remove one organization's address.

PUT/address-apps/{appKey}/addresses/{organizationId}set_organization_address

Set the address one organization sees in a per-organization app.

PUT/address-apps/{appKey}/shared-addressset_shared_address

Set the one address a shared address app shows to everyone.

GET/address-checkscheck_address

Can this address be used as an app, and can it be shown in a frame?

GET/api-keyslist_api_keys

List the API keys of this workspace.

POST/api-keyscreate_api_key

Mint a new API key. The token is returned once and never again.

DELETE/api-keys/{apiKeyId}revoke_api_key

Revoke a key. Takes effect on the next request, with no grace period.

POST/api-keys/{apiKeyId}/rotaterotate_api_key

Replace a key, leaving the old one usable for 24 hours.

GET/app-installationslist_app_installations

The apps installed in this workspace and where they are activated.

DELETE/app-installations/{appKey}uninstall_app

Uninstall an app, removing its widgets from every page.

GET/app-installations/{appKey}get_app_installation

Read one installation.

PUT/app-installations/{appKey}install_app

Install an app in the workspace. Idempotent.

PUT/app-installations/{appKey}/configsave_app_install_config

Save the workspace-wide app config (layer 2).

GET/app-installations/{appKey}/connectionget_app_connection

Which connection does this app read through, and is it healthy?

GET/app-installations/{appKey}/scope-axisget_app_scope_axis

How this app finds the signed-in user's data.

PUT/app-installations/{appKey}/scope-axissave_app_scope_axis

Choose the scope axis for an app.

GET/audit-eventslist_audit_events

Read the audit trail. Append only, never writable.

GET/brandslist_brands

List the brands of this workspace.

POST/brandscreate_brand

Create a brand. The slug is derived from the name unless given.

DELETE/brands/{brandRef}delete_brand

Delete a brand that has no portals and no domains.

GET/brands/{brandRef}get_brand

Read one brand by id or slug.

PATCH/brands/{brandRef}update_brand

Change a brand's name, sender domain or logo assets.

GET/brands/{brandRef}/themeget_brand_theme

Read the active theme tokens of a brand.

PUT/brands/{brandRef}/themesave_brand_theme

Save theme tokens. Creates a new version and activates it.

GET/brands/{brandRef}/theme/versionslist_theme_versions

Read the theme history of a brand, newest first.

POST/brands/{brandRef}/theme/versions/{version}/activateactivate_theme_version

Roll the brand back to an earlier theme version.

GET/catalog/appslist_catalog_apps

Everything this workspace can install, with full manifests.

GET/catalog/apps/{appKey}get_catalog_app

Read one app's manifest.

GET/catalog/apps/{appKey}/widgets/{widgetKey}get_catalog_widget

Read one widget's manifest, schema and defaults.

GET/connectionslist_connections

The connections to source systems. Never returns credentials.

DELETE/connections/{provider}delete_connection

Disconnect a provider. Hard delete, not a soft disable.

GET/connections/{provider}get_connection

Read one connection by provider.

PUT/connections/{provider}save_connection

POST/connections/{provider}/health-checkcheck_connection_health

Verify the credential against the source system, and store the result.

GET/connections/{provider}/objectslist_connection_objects

List records in the source system, to map an organization or a person against.

GET/connectorslist_connectors

Which source systems the platform can talk to, and how they scope data.

GET/domainslist_domains

List the domains of this workspace.

POST/domainscreate_domain

Point a hostname at a portal, or at a brand's default portal.

DELETE/domains/{domainRef}delete_domain

Remove a domain.

GET/domains/{domainRef}get_domain

Read one domain by id or hostname.

PATCH/domains/{domainRef}update_domain

Repoint a domain, or make it the brand's primary one.

GET/groupslist_groups

List groups. Their permissions are unioned into effective access.

POST/groupscreate_group

Create a group.

DELETE/groups/{groupRef}delete_group

Delete an unused group.

PATCH/groups/{groupRef}update_group

Change a group's name or permissions.

GET/impersonation-sessionslist_impersonation_sessions

The impersonation log: who looked at whose data, when, and for how long.

POST/impersonation-sessions/{sessionId}/endend_impersonation_session

End a live impersonation session before it expires.

GET/memberslist_members

List the operators who may work in this workspace.

POST/membersinvite_member

Invite a colleague as an operator of this workspace.

DELETE/members/{userId}revoke_member

Revoke an operator's access. Soft, so the audit trail stays readable.

PATCH/members/{userId}update_member_role

Change an operator's role.

POST/members/{userId}/reinstatereinstate_member

Give a revoked colleague their operator access back.

GET/metaget_meta

Identify the workspace this credential resolves to, and what it may do.

GET/organizationslist_organizations

List organizations, with their mappings to the source systems.

POST/organizationscreate_organization

Create an organization to scope accesses by.

DELETE/organizations/{orgRef}delete_organization

Delete an organization that has no active accesses.

GET/organizations/{orgRef}get_organization

Read one organization.

PATCH/organizations/{orgRef}update_organization

Change an organization's name, match keys, kind or parent.

GET/organizations/{orgRef}/linkslist_organization_links

Read an organization's mappings, keyed by namespace.

DELETE/organizations/{orgRef}/links/{namespace}delete_organization_link

Remove an organization's mapping in one namespace.

PUT/organizations/{orgRef}/links/{namespace}save_organization_link

Map an organization to a record in a source system.

GET/personaslist_personas

List the personas an access can be granted as.

POST/personascreate_persona

Create a persona.

DELETE/personas/{personaRef}delete_persona

Delete an unused persona.

PATCH/personas/{personaRef}update_persona

Rename a persona.

GET/personslist_persons

List the people known in this workspace. Read only.

DELETE/persons/{personId}/links/{namespace}delete_person_link

Revert a person to automatic email matching in one source system.

PUT/persons/{personId}/links/{namespace}save_person_link

Map a person to their identity in a source system.

GET/portalslist_portals

List the portals of this workspace.

POST/portalscreate_portal

Create a portal. It starts offline with a preview token.

DELETE/portals/{portalRef}delete_portal

Delete a portal and everything in it.

GET/portals/{portalRef}get_portal

Read one portal by id or slug.

PATCH/portals/{portalRef}update_portal

Change a portal's name, kind or default persona.

GET/portals/{portalRef}/appslist_portal_apps

Which apps are activated in this portal, and are they healthy?

DELETE/portals/{portalRef}/apps/{appKey}deactivate_app_in_portal

Deactivate an app in a portal, removing its widgets from that portal's pages.

PUT/portals/{portalRef}/apps/{appKey}activate_app_in_portal

Activate an app in a portal, and configure it in the same call. Idempotent.

PUT/portals/{portalRef}/apps/{appKey}/configsave_portal_app_config

Save the per-portal app config (layer 3).

POST/portals/{portalRef}/archivearchive_portal

Mark the portal archived.

GET/portals/{portalRef}/navigationget_portal_navigation

Read the portal navigation, with an ETag for safe updates.

PUT/portals/{portalRef}/navigationsave_portal_navigation

Replace the portal navigation. Requires If-Match.

GET/portals/{portalRef}/pageslist_pages

List the pages of a portal.

POST/portals/{portalRef}/pagescreate_page

Create an empty page, optionally adding it to the navigation.

DELETE/portals/{portalRef}/pages/{pageRef}delete_page

Delete a page and the widget instances on it.

GET/portals/{portalRef}/pages/{pageRef}get_page

Read a page with its normalized blocks and an ETag.

PATCH/portals/{portalRef}/pages/{pageRef}update_page

Rename a page, or change its slug and order.

GET/portals/{portalRef}/pages/{pageRef}/blocksget_page_blocks

Read just the normalized blocks of a page, with an ETag.

POST/portals/{portalRef}/pages/{pageRef}/blocks/reorderreorder_page_blocks

Reorder the blocks of a page.

POST/portals/{portalRef}/pages/{pageRef}/content-blocksadd_content_block

Add a heading, rich text or widget grid block.

DELETE/portals/{portalRef}/pages/{pageRef}/content-blocks/{blockId}delete_content_block

Remove a block from a page.

PATCH/portals/{portalRef}/pages/{pageRef}/content-blocks/{blockId}update_content_block

Change a content block's props, or move it.

PUT/portals/{portalRef}/pages/{pageRef}/layoutsave_page_layout

Replace a page's whole layout. Requires If-Match. Strict.

GET/portals/{portalRef}/pages/{pageRef}/paletteget_page_palette

What can be placed on this page, and will it actually work?

POST/portals/{portalRef}/pages/{pageRef}/widgetsplace_widgets

Place one or more app widgets on a page.

DELETE/portals/{portalRef}/pages/{pageRef}/widgets/{widgetInstanceId}delete_widget

Remove a placed widget from a page.

PATCH/portals/{portalRef}/pages/{pageRef}/widgets/{widgetInstanceId}update_widget

Change a placed widget's config or move it.

GET/portals/{portalRef}/previewget_portal_preview

Read the preview URL and its token.

POST/portals/{portalRef}/preview/rotaterotate_portal_preview

Issue a new preview token, invalidating the old one.

POST/portals/{portalRef}/publishpublish_portal

Take the portal live. Idempotent, and safe to retry.

GET/portals/{portalRef}/readinessget_portal_readiness

Check whether the portal can go live, and what is missing.

GET/portals/{portalRef}/theme-overridesget_portal_theme_overrides

Read the portal's overrides of its brand theme.

PUT/portals/{portalRef}/theme-overridessave_portal_theme_overrides

Override up to four brand tokens for this portal.

POST/portals/{portalRef}/unpublishunpublish_portal

Take the portal offline. Idempotent.

GET/roleslist_roles

List the roles and the permissions they carry.

POST/rolescreate_role

Create a role from permission keys.

DELETE/roles/{roleRef}delete_role

Delete an unused, non-built-in role.

PATCH/roles/{roleRef}update_role

Change a role's name or permissions.

GET/vocabularyget_vocabulary

Every value you would otherwise have to guess, resolved for this workspace.

GET/workspaceget_workspace

Read the workspace this credential belongs to.