1. Packages
  2. Okta
  3. API Docs
  4. idp
  5. getOidc
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi

okta.idp.getOidc

Explore with Pulumi AI

okta logo
Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi

    Get a OIDC IdP from Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.idp.getOidc({
        name: "Example Provider",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.idp.get_oidc(name="Example Provider")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/idp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := idp.LookupOidc(ctx, &idp.LookupOidcArgs{
    			Name: pulumi.StringRef("Example Provider"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.Idp.GetOidc.Invoke(new()
        {
            Name = "Example Provider",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.idp.IdpFunctions;
    import com.pulumi.okta.idp.inputs.GetOidcArgs;
    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 example = IdpFunctions.getOidc(GetOidcArgs.builder()
                .name("Example Provider")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: okta:idp:getOidc
          Arguments:
            name: Example Provider
    

    Using getOidc

    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 getOidc(args: GetOidcArgs, opts?: InvokeOptions): Promise<GetOidcResult>
    function getOidcOutput(args: GetOidcOutputArgs, opts?: InvokeOptions): Output<GetOidcResult>
    def get_oidc(id: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetOidcResult
    def get_oidc_output(id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetOidcResult]
    func LookupOidc(ctx *Context, args *LookupOidcArgs, opts ...InvokeOption) (*LookupOidcResult, error)
    func LookupOidcOutput(ctx *Context, args *LookupOidcOutputArgs, opts ...InvokeOption) LookupOidcResultOutput

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

    public static class GetOidc 
    {
        public static Task<GetOidcResult> InvokeAsync(GetOidcArgs args, InvokeOptions? opts = null)
        public static Output<GetOidcResult> Invoke(GetOidcInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOidcResult> getOidc(GetOidcArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:idp/getOidc:getOidc
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Id of idp.
    Name string
    Name of the idp.
    Id string
    Id of idp.
    Name string
    Name of the idp.
    id String
    Id of idp.
    name String
    Name of the idp.
    id string
    Id of idp.
    name string
    Name of the idp.
    id str
    Id of idp.
    name str
    Name of the idp.
    id String
    Id of idp.
    name String
    Name of the idp.

    getOidc Result

    The following output properties are available:

    AuthorizationBinding string
    The method of making an authorization request.
    AuthorizationUrl string
    IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
    ClientId string
    Unique identifier issued by AS for the Okta IdP instance.
    ClientSecret string
    Client secret issued by AS for the Okta IdP instance.
    IssuerMode string
    Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
    IssuerUrl string
    URI that identifies the issuer.
    JwksBinding string
    The method of making a request for the OIDC JWKS.
    JwksUrl string
    Endpoint where the keys signer publishes its keys in a JWK Set.
    MaxClockSkew int
    Maximum allowable clock-skew when processing messages from the IdP.
    ProtocolType string
    The type of protocol to use.
    Scopes List<string>
    The scopes of the IdP.
    TokenBinding string
    The method of making a token request.
    TokenUrl string
    IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
    Type string
    Type of idp.
    UserInfoBinding string
    The method of making a user info request.
    UserInfoUrl string
    Protected resource endpoint that returns claims about the authenticated user.
    Id string
    Id of idp.
    Name string
    Name of the idp.
    AuthorizationBinding string
    The method of making an authorization request.
    AuthorizationUrl string
    IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
    ClientId string
    Unique identifier issued by AS for the Okta IdP instance.
    ClientSecret string
    Client secret issued by AS for the Okta IdP instance.
    IssuerMode string
    Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
    IssuerUrl string
    URI that identifies the issuer.
    JwksBinding string
    The method of making a request for the OIDC JWKS.
    JwksUrl string
    Endpoint where the keys signer publishes its keys in a JWK Set.
    MaxClockSkew int
    Maximum allowable clock-skew when processing messages from the IdP.
    ProtocolType string
    The type of protocol to use.
    Scopes []string
    The scopes of the IdP.
    TokenBinding string
    The method of making a token request.
    TokenUrl string
    IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
    Type string
    Type of idp.
    UserInfoBinding string
    The method of making a user info request.
    UserInfoUrl string
    Protected resource endpoint that returns claims about the authenticated user.
    Id string
    Id of idp.
    Name string
    Name of the idp.
    authorizationBinding String
    The method of making an authorization request.
    authorizationUrl String
    IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
    clientId String
    Unique identifier issued by AS for the Okta IdP instance.
    clientSecret String
    Client secret issued by AS for the Okta IdP instance.
    issuerMode String
    Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
    issuerUrl String
    URI that identifies the issuer.
    jwksBinding String
    The method of making a request for the OIDC JWKS.
    jwksUrl String
    Endpoint where the keys signer publishes its keys in a JWK Set.
    maxClockSkew Integer
    Maximum allowable clock-skew when processing messages from the IdP.
    protocolType String
    The type of protocol to use.
    scopes List<String>
    The scopes of the IdP.
    tokenBinding String
    The method of making a token request.
    tokenUrl String
    IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
    type String
    Type of idp.
    userInfoBinding String
    The method of making a user info request.
    userInfoUrl String
    Protected resource endpoint that returns claims about the authenticated user.
    id String
    Id of idp.
    name String
    Name of the idp.
    authorizationBinding string
    The method of making an authorization request.
    authorizationUrl string
    IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
    clientId string
    Unique identifier issued by AS for the Okta IdP instance.
    clientSecret string
    Client secret issued by AS for the Okta IdP instance.
    issuerMode string
    Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
    issuerUrl string
    URI that identifies the issuer.
    jwksBinding string
    The method of making a request for the OIDC JWKS.
    jwksUrl string
    Endpoint where the keys signer publishes its keys in a JWK Set.
    maxClockSkew number
    Maximum allowable clock-skew when processing messages from the IdP.
    protocolType string
    The type of protocol to use.
    scopes string[]
    The scopes of the IdP.
    tokenBinding string
    The method of making a token request.
    tokenUrl string
    IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
    type string
    Type of idp.
    userInfoBinding string
    The method of making a user info request.
    userInfoUrl string
    Protected resource endpoint that returns claims about the authenticated user.
    id string
    Id of idp.
    name string
    Name of the idp.
    authorization_binding str
    The method of making an authorization request.
    authorization_url str
    IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
    client_id str
    Unique identifier issued by AS for the Okta IdP instance.
    client_secret str
    Client secret issued by AS for the Okta IdP instance.
    issuer_mode str
    Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
    issuer_url str
    URI that identifies the issuer.
    jwks_binding str
    The method of making a request for the OIDC JWKS.
    jwks_url str
    Endpoint where the keys signer publishes its keys in a JWK Set.
    max_clock_skew int
    Maximum allowable clock-skew when processing messages from the IdP.
    protocol_type str
    The type of protocol to use.
    scopes Sequence[str]
    The scopes of the IdP.
    token_binding str
    The method of making a token request.
    token_url str
    IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
    type str
    Type of idp.
    user_info_binding str
    The method of making a user info request.
    user_info_url str
    Protected resource endpoint that returns claims about the authenticated user.
    id str
    Id of idp.
    name str
    Name of the idp.
    authorizationBinding String
    The method of making an authorization request.
    authorizationUrl String
    IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
    clientId String
    Unique identifier issued by AS for the Okta IdP instance.
    clientSecret String
    Client secret issued by AS for the Okta IdP instance.
    issuerMode String
    Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
    issuerUrl String
    URI that identifies the issuer.
    jwksBinding String
    The method of making a request for the OIDC JWKS.
    jwksUrl String
    Endpoint where the keys signer publishes its keys in a JWK Set.
    maxClockSkew Number
    Maximum allowable clock-skew when processing messages from the IdP.
    protocolType String
    The type of protocol to use.
    scopes List<String>
    The scopes of the IdP.
    tokenBinding String
    The method of making a token request.
    tokenUrl String
    IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
    type String
    Type of idp.
    userInfoBinding String
    The method of making a user info request.
    userInfoUrl String
    Protected resource endpoint that returns claims about the authenticated user.
    id String
    Id of idp.
    name String
    Name of the idp.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.9.2 published on Tuesday, Jun 25, 2024 by Pulumi