Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.identitytoolkit/v2.OauthIdpConfig
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Create an Oidc Idp configuration for an Identity Toolkit project.
Create OauthIdpConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OauthIdpConfig(name: string, args: OauthIdpConfigArgs, opts?: CustomResourceOptions);@overload
def OauthIdpConfig(resource_name: str,
                   args: OauthIdpConfigArgs,
                   opts: Optional[ResourceOptions] = None)
@overload
def OauthIdpConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   tenant_id: Optional[str] = None,
                   client_id: Optional[str] = None,
                   client_secret: Optional[str] = None,
                   display_name: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   issuer: Optional[str] = None,
                   name: Optional[str] = None,
                   oauth_idp_config_id: Optional[str] = None,
                   project: Optional[str] = None,
                   response_type: Optional[GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeArgs] = None)func NewOauthIdpConfig(ctx *Context, name string, args OauthIdpConfigArgs, opts ...ResourceOption) (*OauthIdpConfig, error)public OauthIdpConfig(string name, OauthIdpConfigArgs args, CustomResourceOptions? opts = null)
public OauthIdpConfig(String name, OauthIdpConfigArgs args)
public OauthIdpConfig(String name, OauthIdpConfigArgs args, CustomResourceOptions options)
type: google-native:identitytoolkit/v2:OauthIdpConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OauthIdpConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OauthIdpConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OauthIdpConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OauthIdpConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OauthIdpConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var oauthIdpConfigResource = new GoogleNative.IdentityToolkit.V2.OauthIdpConfig("oauthIdpConfigResource", new()
{
    TenantId = "string",
    ClientId = "string",
    ClientSecret = "string",
    DisplayName = "string",
    Enabled = false,
    Issuer = "string",
    Name = "string",
    OauthIdpConfigId = "string",
    Project = "string",
    ResponseType = new GoogleNative.IdentityToolkit.V2.Inputs.GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeArgs
    {
        Code = false,
        IdToken = false,
        Token = false,
    },
});
example, err := identitytoolkit.NewOauthIdpConfig(ctx, "oauthIdpConfigResource", &identitytoolkit.OauthIdpConfigArgs{
	TenantId:         pulumi.String("string"),
	ClientId:         pulumi.String("string"),
	ClientSecret:     pulumi.String("string"),
	DisplayName:      pulumi.String("string"),
	Enabled:          pulumi.Bool(false),
	Issuer:           pulumi.String("string"),
	Name:             pulumi.String("string"),
	OauthIdpConfigId: pulumi.String("string"),
	Project:          pulumi.String("string"),
	ResponseType: &identitytoolkit.GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeArgs{
		Code:    pulumi.Bool(false),
		IdToken: pulumi.Bool(false),
		Token:   pulumi.Bool(false),
	},
})
var oauthIdpConfigResource = new OauthIdpConfig("oauthIdpConfigResource", OauthIdpConfigArgs.builder()
    .tenantId("string")
    .clientId("string")
    .clientSecret("string")
    .displayName("string")
    .enabled(false)
    .issuer("string")
    .name("string")
    .oauthIdpConfigId("string")
    .project("string")
    .responseType(GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeArgs.builder()
        .code(false)
        .idToken(false)
        .token(false)
        .build())
    .build());
oauth_idp_config_resource = google_native.identitytoolkit.v2.OauthIdpConfig("oauthIdpConfigResource",
    tenant_id="string",
    client_id="string",
    client_secret="string",
    display_name="string",
    enabled=False,
    issuer="string",
    name="string",
    oauth_idp_config_id="string",
    project="string",
    response_type={
        "code": False,
        "id_token": False,
        "token": False,
    })
const oauthIdpConfigResource = new google_native.identitytoolkit.v2.OauthIdpConfig("oauthIdpConfigResource", {
    tenantId: "string",
    clientId: "string",
    clientSecret: "string",
    displayName: "string",
    enabled: false,
    issuer: "string",
    name: "string",
    oauthIdpConfigId: "string",
    project: "string",
    responseType: {
        code: false,
        idToken: false,
        token: false,
    },
});
type: google-native:identitytoolkit/v2:OauthIdpConfig
properties:
    clientId: string
    clientSecret: string
    displayName: string
    enabled: false
    issuer: string
    name: string
    oauthIdpConfigId: string
    project: string
    responseType:
        code: false
        idToken: false
        token: false
    tenantId: string
OauthIdpConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OauthIdpConfig resource accepts the following input properties:
- TenantId string
- ClientId string
- The client id of an OAuth client.
- ClientSecret string
- The client secret of the OAuth client, to enable OIDC code flow.
- DisplayName string
- The config's display name set by developers.
- Enabled bool
- True if allows the user to sign in with the provider.
- Issuer string
- For OIDC Idps, the issuer identifier.
- Name string
- The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
- OauthIdp stringConfig Id 
- The id to use for this config.
- Project string
- ResponseType Pulumi.Google Native. Identity Toolkit. V2. Inputs. Google Cloud Identitytoolkit Admin V2OAuth Response Type 
- The response type to request for in the OAuth authorization flow. You can set either id_tokenorcodeto true, but not both. Setting both types to be simultaneously true ({code: true, id_token: true}) is not yet supported.
- TenantId string
- ClientId string
- The client id of an OAuth client.
- ClientSecret string
- The client secret of the OAuth client, to enable OIDC code flow.
- DisplayName string
- The config's display name set by developers.
- Enabled bool
- True if allows the user to sign in with the provider.
- Issuer string
- For OIDC Idps, the issuer identifier.
- Name string
- The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
- OauthIdp stringConfig Id 
- The id to use for this config.
- Project string
- ResponseType GoogleCloud Identitytoolkit Admin V2OAuth Response Type Args 
- The response type to request for in the OAuth authorization flow. You can set either id_tokenorcodeto true, but not both. Setting both types to be simultaneously true ({code: true, id_token: true}) is not yet supported.
- tenantId String
- clientId String
- The client id of an OAuth client.
- clientSecret String
- The client secret of the OAuth client, to enable OIDC code flow.
- displayName String
- The config's display name set by developers.
- enabled Boolean
- True if allows the user to sign in with the provider.
- issuer String
- For OIDC Idps, the issuer identifier.
- name String
- The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
- oauthIdp StringConfig Id 
- The id to use for this config.
- project String
- responseType GoogleCloud Identitytoolkit Admin V2OAuth Response Type 
- The response type to request for in the OAuth authorization flow. You can set either id_tokenorcodeto true, but not both. Setting both types to be simultaneously true ({code: true, id_token: true}) is not yet supported.
- tenantId string
- clientId string
- The client id of an OAuth client.
- clientSecret string
- The client secret of the OAuth client, to enable OIDC code flow.
- displayName string
- The config's display name set by developers.
- enabled boolean
- True if allows the user to sign in with the provider.
- issuer string
- For OIDC Idps, the issuer identifier.
- name string
- The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
- oauthIdp stringConfig Id 
- The id to use for this config.
- project string
- responseType GoogleCloud Identitytoolkit Admin V2OAuth Response Type 
- The response type to request for in the OAuth authorization flow. You can set either id_tokenorcodeto true, but not both. Setting both types to be simultaneously true ({code: true, id_token: true}) is not yet supported.
- tenant_id str
- client_id str
- The client id of an OAuth client.
- client_secret str
- The client secret of the OAuth client, to enable OIDC code flow.
- display_name str
- The config's display name set by developers.
- enabled bool
- True if allows the user to sign in with the provider.
- issuer str
- For OIDC Idps, the issuer identifier.
- name str
- The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
- oauth_idp_ strconfig_ id 
- The id to use for this config.
- project str
- response_type GoogleCloud Identitytoolkit Admin V2OAuth Response Type Args 
- The response type to request for in the OAuth authorization flow. You can set either id_tokenorcodeto true, but not both. Setting both types to be simultaneously true ({code: true, id_token: true}) is not yet supported.
- tenantId String
- clientId String
- The client id of an OAuth client.
- clientSecret String
- The client secret of the OAuth client, to enable OIDC code flow.
- displayName String
- The config's display name set by developers.
- enabled Boolean
- True if allows the user to sign in with the provider.
- issuer String
- For OIDC Idps, the issuer identifier.
- name String
- The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
- oauthIdp StringConfig Id 
- The id to use for this config.
- project String
- responseType Property Map
- The response type to request for in the OAuth authorization flow. You can set either id_tokenorcodeto true, but not both. Setting both types to be simultaneously true ({code: true, id_token: true}) is not yet supported.
Outputs
All input properties are implicitly available as output properties. Additionally, the OauthIdpConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
GoogleCloudIdentitytoolkitAdminV2OAuthResponseType, GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeArgs              
GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeResponse, GoogleCloudIdentitytoolkitAdminV2OAuthResponseTypeResponseArgs                
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.