1. Packages
  2. Zitadel
  3. API Docs
  4. getIdpOauth
Viewing docs for zitadel v0.2.0
published on Monday, Mar 24, 2025 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-zitadel

zitadel.getIdpOauth

zitadel logo
Viewing docs for zitadel v0.2.0
published on Monday, Mar 24, 2025 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-zitadel

    Datasource representing a generic OAuth2 IDP on the instance.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumi.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = Zitadel.GetIdpOauth.Invoke(new()
    {
        Id = "123456789012345678",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.LookupIdpOauth(ctx, &zitadel.LookupIdpOauthArgs{
			Id: "123456789012345678",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.ZitadelFunctions;
import com.pulumi.zitadel.inputs.GetIdpOauthArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = ZitadelFunctions.getIdpOauth(GetIdpOauthArgs.builder()
            .id("123456789012345678")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumi/zitadel";

const default = zitadel.getIdpOauth({
    id: "123456789012345678",
});

    import pulumi
import pulumi_zitadel as zitadel

default = zitadel.get_idp_oauth(id="123456789012345678")

    variables:
  default:
    fn::invoke:
      Function: zitadel:getIdpOauth
      Arguments:
        id: '123456789012345678'

    Using getIdpOauth

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIdpOauth(args: GetIdpOauthArgs, opts?: InvokeOptions): Promise<GetIdpOauthResult>
function getIdpOauthOutput(args: GetIdpOauthOutputArgs, opts?: InvokeOptions): Output<GetIdpOauthResult>
    def get_idp_oauth(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIdpOauthResult
def get_idp_oauth_output(id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetIdpOauthResult]
    func LookupIdpOauth(ctx *Context, args *LookupIdpOauthArgs, opts ...InvokeOption) (*LookupIdpOauthResult, error)
func LookupIdpOauthOutput(ctx *Context, args *LookupIdpOauthOutputArgs, opts ...InvokeOption) LookupIdpOauthResultOutput

    > Note: This function is named LookupIdpOauth in the Go SDK.

    public static class GetIdpOauth 
{
    public static Task<GetIdpOauthResult> InvokeAsync(GetIdpOauthArgs args, InvokeOptions? opts = null)
    public static Output<GetIdpOauthResult> Invoke(GetIdpOauthInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIdpOauthResult> getIdpOauth(GetIdpOauthArgs args, InvokeOptions options)
public static Output<GetIdpOauthResult> getIdpOauth(GetIdpOauthArgs args, InvokeOptions options)

    fn::invoke:
  function: zitadel:index/getIdpOauth:getIdpOauth
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    id String
    The ID of this resource.

    getIdpOauth Result

    The following output properties are available:

    AuthorizationEndpoint string
    The authorization endpoint
    ClientId string
    client id generated by the identity provider
    ClientSecret string
    client secret generated by the identity provider
    Id string
    The ID of this resource.
    IdAttribute string
    The id attribute
    IsAutoCreation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    IsAutoUpdate bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    IsCreationAllowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enabled if users are able to link an existing ZITADEL user with an external account
    Name string
    Name of the IDP
    Scopes List<string>
    the scopes requested by ZITADEL during the request on the identity provider
    TokenEndpoint string
    The token endpoint
    UserEndpoint string
    The user endpoint
    AuthorizationEndpoint string
    The authorization endpoint
    ClientId string
    client id generated by the identity provider
    ClientSecret string
    client secret generated by the identity provider
    Id string
    The ID of this resource.
    IdAttribute string
    The id attribute
    IsAutoCreation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    IsAutoUpdate bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    IsCreationAllowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enabled if users are able to link an existing ZITADEL user with an external account
    Name string
    Name of the IDP
    Scopes []string
    the scopes requested by ZITADEL during the request on the identity provider
    TokenEndpoint string
    The token endpoint
    UserEndpoint string
    The user endpoint
    authorizationEndpoint String
    The authorization endpoint
    clientId String
    client id generated by the identity provider
    clientSecret String
    client secret generated by the identity provider
    id String
    The ID of this resource.
    idAttribute String
    The id attribute
    isAutoCreation Boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate Boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed Boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enabled if users are able to link an existing ZITADEL user with an external account
    name String
    Name of the IDP
    scopes List<String>
    the scopes requested by ZITADEL during the request on the identity provider
    tokenEndpoint String
    The token endpoint
    userEndpoint String
    The user endpoint
    authorizationEndpoint string
    The authorization endpoint
    clientId string
    client id generated by the identity provider
    clientSecret string
    client secret generated by the identity provider
    id string
    The ID of this resource.
    idAttribute string
    The id attribute
    isAutoCreation boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enabled if users are able to link an existing ZITADEL user with an external account
    name string
    Name of the IDP
    scopes string[]
    the scopes requested by ZITADEL during the request on the identity provider
    tokenEndpoint string
    The token endpoint
    userEndpoint string
    The user endpoint
    authorization_endpoint str
    The authorization endpoint
    client_id str
    client id generated by the identity provider
    client_secret str
    client secret generated by the identity provider
    id str
    The ID of this resource.
    id_attribute str
    The id attribute
    is_auto_creation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    is_auto_update bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    is_creation_allowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enabled if users are able to link an existing ZITADEL user with an external account
    name str
    Name of the IDP
    scopes Sequence[str]
    the scopes requested by ZITADEL during the request on the identity provider
    token_endpoint str
    The token endpoint
    user_endpoint str
    The user endpoint
    authorizationEndpoint String
    The authorization endpoint
    clientId String
    client id generated by the identity provider
    clientSecret String
    client secret generated by the identity provider
    id String
    The ID of this resource.
    idAttribute String
    The id attribute
    isAutoCreation Boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate Boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed Boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enabled if users are able to link an existing ZITADEL user with an external account
    name String
    Name of the IDP
    scopes List<String>
    the scopes requested by ZITADEL during the request on the identity provider
    tokenEndpoint String
    The token endpoint
    userEndpoint String
    The user endpoint

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    Viewing docs for zitadel v0.2.0
    published on Monday, Mar 24, 2025 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-zitadel
      Try Pulumi Cloud free. Your team will thank you.