• management
• Management
• ConnectionOptionsGoogleApps

Interface ConnectionOptionsGoogleApps

Options for the 'google-apps' connection

interface ConnectionOptionsGoogleApps {
non_persistent_attrs?: ConnectionNonPersistentAttrs;
admin_access_token?: string;
admin_access_token_expiresin?: string;
admin_refresh_token?: string;
allow_setting_login_scopes?: boolean;
api_enable_groups?: boolean;
api_enable_users?: boolean;
client_id: string;
client_secret?: string;
domain?: string;
domain_aliases?: ConnectionDomainAliases;
email?: boolean;
ext_agreed_terms?: boolean;
ext_groups?: boolean;
ext_groups_extended?: boolean;
ext_is_admin?: boolean;
ext_is_suspended?: boolean;
federated_connections_access_tokens?:
| ConnectionFederatedConnectionsAccessTokens
| null;
handle_login_from_social?: boolean;
icon_url?: string;
map_user_id_to_id?: boolean;
profile?: boolean;
scope?: ConnectionScopeGoogleApps;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
tenant_domain?: string;
upstream_params?: ConnectionUpstreamParams;
key: string: any;
}

Hierarchy (View Summary)

• ConnectionOptionsCommon
  • ConnectionOptionsGoogleApps

Indexable

Accepts any additional properties

Index

Properties

non_persistent_attrs?admin_access_token?admin_access_token_expiresin?admin_refresh_token?allow_setting_login_scopes?api_enable_groups?api_enable_users?client_idclient_secret?domain?domain_aliases?email?ext_agreed_terms?ext_groups?ext_groups_extended?ext_is_admin?ext_is_suspended?federated_connections_access_tokens?handle_login_from_social?icon_url?map_user_id_to_id?profile?scope?set_user_root_attributes?tenant_domain?upstream_params?

Properties

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

Optionaladmin_access_token

admin_access_token?: string

Optionaladmin_access_token_expiresin

admin_access_token_expiresin?: string

Optionaladmin_refresh_token

admin_refresh_token?: string

Optionalallow_setting_login_scopes

allow_setting_login_scopes?: boolean

When true, allows customization of OAuth scopes requested during user login. Custom scopes are appended to the mandatory email and profile scopes. When false or omitted, only the default email and profile scopes are used. This property is automatically enabled when Token Vault or Connected Accounts features are activated.

Optionalapi_enable_groups

api_enable_groups?: boolean

Optionalapi_enable_users

api_enable_users?: boolean

client_id

client_id: string

Optionalclient_secret

client_secret?: string

Optionaldomain

domain?: string

Optionaldomain_aliases

domain_aliases?: ConnectionDomainAliases

Optionalemail

email?: boolean

Whether the OAuth flow requests the email scope.

Optionalext_agreed_terms

ext_agreed_terms?: boolean

Optionalext_groups

ext_groups?: boolean

Optionalext_groups_extended

ext_groups_extended?: boolean

Controls whether enriched group entries include id, email, name (true) or only the group name (false); can only be set when ext_groups is true.

Optionalext_is_admin

ext_is_admin?: boolean

Optionalext_is_suspended

ext_is_suspended?: boolean

Optionalfederated_connections_access_tokens

federated_connections_access_tokens?:
| ConnectionFederatedConnectionsAccessTokens
| null

Optionalhandle_login_from_social

handle_login_from_social?: boolean

Optionalicon_url

icon_url?: string

Optionalmap_user_id_to_id

map_user_id_to_id?: boolean

Determines how Auth0 generates the user_id for Google Workspace users. When false (default), the user's email address is used. When true, Google's stable numeric user ID is used instead, which persists even if the user's email changes. This setting can only be configured when creating the connection and cannot be changed afterward.

Optionalprofile

profile?: boolean

Whether the OAuth flow requests the profile scope.

Optionalscope

scope?: ConnectionScopeGoogleApps

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

Optionaltenant_domain

tenant_domain?: string

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties non_persistent_attrsadmin_access_tokenadmin_access_token_expiresinadmin_refresh_tokenallow_setting_login_scopesapi_enable_groupsapi_enable_usersclient_idclient_secretdomaindomain_aliasesemailext_agreed_termsext_groupsext_groups_extendedext_is_adminext_is_suspendedfederated_connections_access_tokenshandle_login_from_socialicon_urlmap_user_id_to_idprofilescopeset_user_root_attributestenant_domainupstream_params