Class GoogleIdentityProviderArgs

Inheritance

System.Object

InputArgs

ResourceArgs

GoogleIdentityProviderArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Keycloak.Oidc

Assembly: Pulumi.Keycloak.dll

Syntax

public sealed class GoogleIdentityProviderArgs : ResourceArgs

Constructors

GoogleIdentityProviderArgs()

Declaration

public GoogleIdentityProviderArgs()

Properties

AcceptsPromptNoneForwardFromClient

This is just used together with Identity Provider Authenticator or when kc_idp_hint points to this identity provider. In case that client sends a request with prompt=none and user is not yet authenticated, the error will not be directly returned to client, but the request with prompt=none will be forwarded to this identity provider.

Declaration

public Input<bool> AcceptsPromptNoneForwardFromClient { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AddReadTokenRoleOnCreate

Enable/disable if new users can read any stored tokens. This assigns the broker.read-token role.

Declaration

public Input<bool> AddReadTokenRoleOnCreate { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AuthenticateByDefault

Enable/disable authenticate users by default.

Declaration

public Input<bool> AuthenticateByDefault { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ClientId

Client ID.

Declaration

public Input<string> ClientId { get; set; }

Property Value

Type	Description
Input<System.String>

ClientSecret

Client Secret.

Declaration

public Input<string> ClientSecret { get; set; }

Property Value

Type	Description
Input<System.String>

DefaultScopes

The scopes to be sent when asking for authorization. See the documentation for possible values, separator and default value'. Default: 'openid profile email'

Declaration

public Input<string> DefaultScopes { get; set; }

Property Value

Type	Description
Input<System.String>

DisableUserInfo

Disable usage of User Info service to obtain additional user information? Default is to use this OIDC service.

Declaration

public Input<bool> DisableUserInfo { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Enabled

Enable/disable this identity provider.

Declaration

public Input<bool> Enabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ExtraConfig

Declaration

public InputMap<object> ExtraConfig { get; set; }

Property Value

Type	Description
InputMap<System.Object>

FirstBrokerLoginFlowAlias

Alias of authentication flow, which is triggered after first login with this identity provider. Term 'First Login' means that there is not yet existing Keycloak account linked with the authenticated identity provider account.

Declaration

public Input<string> FirstBrokerLoginFlowAlias { get; set; }

Property Value

Type	Description
Input<System.String>

HideOnLoginPage

Hide On Login Page.

Declaration

public Input<bool> HideOnLoginPage { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HostedDomain

Set 'hd' query parameter when logging in with Google. Google will list accounts only for this domain. Keycloak validates that the returned identity token has a claim for this domain. When '*' is entered, any hosted account can be used.

Declaration

public Input<string> HostedDomain { get; set; }

Property Value

Type	Description
Input<System.String>

LinkOnly

If true, users cannot log in through this provider. They can only link to this provider. This is useful if you don't want to allow login from the provider, but want to integrate with a provider

Declaration

public Input<bool> LinkOnly { get; set; }

Property Value

Type	Description
Input<System.Boolean>

PostBrokerLoginFlowAlias

Alias of authentication flow, which is triggered after each login with this identity provider. Useful if you want additional verification of each user authenticated with this identity provider (for example OTP). Leave this empty if you don't want any additional authenticators to be triggered after login with this identity provider. Also note, that authenticator implementations must assume that user is already set in ClientSession as identity provider already set it.

Declaration

public Input<string> PostBrokerLoginFlowAlias { get; set; }

Property Value

Type	Description
Input<System.String>

ProviderId

provider id, is always google, unless you have a extended custom implementation

Declaration

public Input<string> ProviderId { get; set; }

Property Value

Type	Description
Input<System.String>

Realm

Realm Name

Declaration

public Input<string> Realm { get; set; }

Property Value

Type	Description
Input<System.String>

RequestRefreshToken

Set 'access_type' query parameter to 'offline' when redirecting to google authorization endpoint, to get a refresh token back. Useful if planning to use Token Exchange to retrieve Google token to access Google APIs when the user is not at the browser.

Declaration

public Input<bool> RequestRefreshToken { get; set; }

Property Value

Type	Description
Input<System.Boolean>

StoreToken

Enable/disable if tokens must be stored after authenticating users.

Declaration

public Input<bool> StoreToken { get; set; }

Property Value

Type	Description
Input<System.Boolean>

TrustEmail

If enabled then email provided by this provider is not verified even if verification is enabled for the realm.

Declaration

public Input<bool> TrustEmail { get; set; }

Property Value

Type	Description
Input<System.Boolean>

UseUserIpParam

Set 'userIp' query parameter when invoking on Google's User Info service. This will use the user's ip address. Useful if Google is throttling access to the User Info service.

Declaration

public Input<bool> UseUserIpParam { get; set; }

Property Value

Type	Description
Input<System.Boolean>