← All packages

Okta

Pulumi Official

Package maintained by Pulumi

v3.15.0 published on Tuesday, Aug 16, 2022 by Pulumi

Source code

getOidc

Use this data source to retrieve a OIDC IdP from Okta.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = Okta.Idp.GetOidc.Invoke(new()
    {
        Name = "Example Provider",
    });

});

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/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
	})
}

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());

    }
}

import pulumi
import pulumi_okta as okta

example = okta.idp.get_oidc(name="Example Provider")

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

const example = pulumi.output(okta.idp.getOidc({
    name: "Example Provider",
}));

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: The id of the idp to retrieve, conflicts with name.
Name string: The name of the idp to retrieve, conflicts with id.

Id string: The id of the idp to retrieve, conflicts with name.
Name string: The name of the idp to retrieve, conflicts with id.

id String: The id of the idp to retrieve, conflicts with name.
name String: The name of the idp to retrieve, conflicts with id.

id string: The id of the idp to retrieve, conflicts with name.
name string: The name of the idp to retrieve, conflicts with id.

id str: The id of the idp to retrieve, conflicts with name.
name str: The name of the idp to retrieve, conflicts with id.

id String: The id of the idp to retrieve, conflicts with name.
name String: The name of the idp to retrieve, conflicts with id.

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, or a custom domain URL.
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, or a custom domain URL.
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, or a custom domain URL.
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, or a custom domain URL.
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, or a custom domain URL.
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, or a custom domain URL.
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: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.