Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 3.66 KB

EmbedSsoParams.md

File metadata and controls

22 lines (18 loc) · 3.66 KB

EmbedSsoParams

Properties

Name Type Description Notes
target_url string The complete URL of the Looker UI page to display in the embed context. For example, to display the dashboard with id 34, `target_url` would look like: `https://mycompany.looker.com:9999/dashboards/34`. `target_uri` MUST contain a scheme (HTTPS), domain name, and URL path. Port must be included if it is required to reach the Looker server from browser clients. If the Looker instance is behind a load balancer or other proxy, `target_uri` must be the public-facing domain name and port required to reach the Looker instance, not the actual internal network machine name of the Looker instance.
session_length int Number of seconds the SSO embed session will be valid after the embed session is started. Defaults to 300 seconds. Maximum session length accepted is 2592000 seconds (30 days). [optional]
force_logout_login bool When true, the embed session will purge any residual Looker login state (such as in browser cookies) before creating a new login state with the given embed user info. Defaults to true. [optional]
external_user_id string A value from an external system that uniquely identifies the embed user. Since the user_ids of Looker embed users may change with every embed session, external_user_id provides a way to assign a known, stable user identifier across multiple embed sessions. [optional]
first_name string First name of the embed user. Defaults to 'Embed' if not specified [optional]
last_name string Last name of the embed user. Defaults to 'User' if not specified [optional]
user_timezone string Sets the user timezone for the embed user session, if the User Specific Timezones setting is enabled in the Looker admin settings. A value of `null` forces the embed user to use the Looker Application Default Timezone. You MUST omit this property from the request if the User Specific Timezones setting is disabled. Timezone values are validated against the IANA Timezone standard and can be seen in the Application Time Zone dropdown list on the Looker General Settings admin page. [optional]
permissions string[] List of Looker permission names to grant to the embed user. Requested permissions will be filtered to permissions allowed for embed sessions. [optional]
models string[] List of model names that the embed user may access [optional]
group_ids string[] List of Looker group ids in which to enroll the embed user [optional]
external_group_id string A unique value identifying an embed-exclusive group. Multiple embed users using the same `external_group_id` value will be able to share Looker content with each other. Content and embed users associated with the `external_group_id` will not be accessible to normal Looker users or embed users not associated with this `external_group_id`. [optional]
user_attributes object A dictionary of name-value pairs associating a Looker user attribute name with a value. [optional]
secret_id string Id of the embed secret to use to sign this SSO url. If specified, the value must be an id of a valid (active) secret defined in the Looker instance. If not specified, the URL will be signed with the newest active embed secret defined in the Looker instance. [optional]

[Back to Model list] [Back to API list] [Back to README]