Table of Contents

Class EventStreamCloudEventConnectionUpdatedObject6Options

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll

Options for the 'google-apps' connection

[Serializable]
public record EventStreamCloudEventConnectionUpdatedObject6Options : IJsonOnDeserialized, IEquatable<EventStreamCloudEventConnectionUpdatedObject6Options>
Inheritance
EventStreamCloudEventConnectionUpdatedObject6Options
Implements
Inherited Members
Extension Methods

Properties

AdditionalProperties 

[JsonIgnore]
public ReadOnlyAdditionalProperties AdditionalProperties { get; }

Property Value

ReadOnlyAdditionalProperties

AdminAccessTokenExpiresin

Expiration timestamp for the admin_access_token in ISO 8601 format. Auth0 uses this value to determine when to refresh the token.

[JsonPropertyName("admin_access_token_expiresin")]
public DateTime? AdminAccessTokenExpiresin { get; set; }

Property Value

DateTime?

AllowSettingLoginScopes

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.

[JsonPropertyName("allow_setting_login_scopes")]
public bool? AllowSettingLoginScopes { get; set; }

Property Value

bool?

ApiEnableGroups 

[JsonPropertyName("api_enable_groups")]
public bool? ApiEnableGroups { get; set; }

Property Value

bool?

ApiEnableUsers

Enables integration with the Google Workspace Admin SDK Directory API. When true, Auth0 can retrieve extended user attributes (admin status, suspension status, group memberships) and supports inbound directory provisioning (SCIM). Defaults to true.

[JsonPropertyName("api_enable_users")]
public bool? ApiEnableUsers { get; set; }

Property Value

bool?

ClientId

Your Google OAuth 2.0 client ID. You can find this in your Google Cloud Console under the OAuth 2.0 Client IDs section.

[JsonPropertyName("client_id")]
public required string ClientId { get; set; }

Property Value

string

Domain

Primary Google Workspace domain name that users must belong to.

[JsonPropertyName("domain")]
public string? Domain { get; set; }

Property Value

string

DomainAliases

Email domains associated with this connection for Home Realm Discovery (HRD). When a user's email matches one of these domains, they are automatically routed to this connection during authentication.

[JsonPropertyName("domain_aliases")]
public IEnumerable<string>? DomainAliases { get; set; }

Property Value

IEnumerable<string>

Email

Whether the OAuth flow requests the email scope.

[JsonPropertyName("email")]
public bool? Email { get; set; }

Property Value

bool?

ExtAgreedTerms

Fetches the agreedToTerms flag from the Google Directory profile.

[JsonPropertyName("ext_agreed_terms")]
public bool? ExtAgreedTerms { get; set; }

Property Value

bool?

ExtGroups

Enables enrichment with Google group memberships (required for ext_groups_extended).

[JsonPropertyName("ext_groups")]
public bool? ExtGroups { get; set; }

Property Value

bool?

ExtGroupsExtended

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.

[JsonPropertyName("ext_groups_extended")]
public bool? ExtGroupsExtended { get; set; }

Property Value

bool?

ExtIsAdmin

Fetches the Google Directory admin flag for the signing-in user.

[JsonPropertyName("ext_is_admin")]
public bool? ExtIsAdmin { get; set; }

Property Value

bool?

ExtIsSuspended

Fetches the Google Directory suspended flag for the signing-in user.

[JsonPropertyName("ext_is_suspended")]
public bool? ExtIsSuspended { get; set; }

Property Value

bool?

FederatedConnectionsAccessTokens 

[JsonPropertyName("federated_connections_access_tokens")]
public EventStreamCloudEventConnectionUpdatedObject6OptionsFederatedConnectionsAccessTokens? FederatedConnectionsAccessTokens { get; set; }

Property Value

EventStreamCloudEventConnectionUpdatedObject6OptionsFederatedConnectionsAccessTokens

HandleLoginFromSocial

When enabled, users who sign in with their Google account through a social login will be automatically routed to this Google Workspace connection if their email domain matches the configured tenant_domain or domain_aliases. This ensures enterprise users authenticate through their organization's Google Workspace identity provider rather than through a generic Google social login, enabling access to directory-based attributes and enforcing organizational security policies. Defaults to true for new connections.

[JsonPropertyName("handle_login_from_social")]
public bool? HandleLoginFromSocial { get; set; }

Property Value

bool?

IconUrl

URL for the connection icon displayed in Auth0 login pages. Accepts HTTPS URLs. Used for visual branding in authentication flows.

[JsonPropertyName("icon_url")]
public string? IconUrl { get; set; }

Property Value

string

MapUserIdToId

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.

[JsonPropertyName("map_user_id_to_id")]
public bool? MapUserIdToId { get; set; }

Property Value

bool?

NonPersistentAttrs

An array of user fields that should not be stored in the Auth0 database (https://auth0.com/docs/security/data-security/denylist)

[JsonPropertyName("non_persistent_attrs")]
public IEnumerable<string>? NonPersistentAttrs { get; set; }

Property Value

IEnumerable<string>

Profile

Whether the OAuth flow requests the profile scope.

[JsonPropertyName("profile")]
public bool? Profile { get; set; }

Property Value

bool?

Scope

Additional OAuth scopes requested beyond the default email profile scopes; ignored unless allow_setting_login_scopes is true.

[JsonPropertyName("scope")]
public IEnumerable<string>? Scope { get; set; }

Property Value

IEnumerable<string>

SetUserRootAttributes 

[JsonPropertyName("set_user_root_attributes")]
public EventStreamCloudEventConnectionUpdatedObject6OptionsSetUserRootAttributesEnum? SetUserRootAttributes { get; set; }

Property Value

EventStreamCloudEventConnectionUpdatedObject6OptionsSetUserRootAttributesEnum?

TenantDomain

The Google Workspace primary domain used to identify the organization during authentication.

[JsonPropertyName("tenant_domain")]
public string? TenantDomain { get; set; }

Property Value

string

UpstreamParams 

[JsonPropertyName("upstream_params")]
public Dictionary<string, object?>? UpstreamParams { get; set; }

Property Value

Dictionary<string, object>

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.