Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi
okta.idp.getOidc
Explore with Pulumi AI
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:
getOidc Result
The following output properties are available:
- string
- The method of making an authorization request.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- Client
Id string - Unique identifier issued by AS for the Okta IdP instance.
- Client
Secret string - Client secret issued by AS for the Okta IdP instance.
- Issuer
Mode string - Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
- Issuer
Url string - URI that identifies the issuer.
- Jwks
Binding string - The method of making a request for the OIDC JWKS.
- Jwks
Url string - Endpoint where the keys signer publishes its keys in a JWK Set.
- Max
Clock intSkew - Maximum allowable clock-skew when processing messages from the IdP.
- Protocol
Type string - The type of protocol to use.
- Scopes List<string>
- The scopes of the IdP.
- Token
Binding string - The method of making a token request.
- Token
Url string - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- Type string
- Type of idp.
- User
Info stringBinding - The method of making a user info request.
- User
Info stringUrl - Protected resource endpoint that returns claims about the authenticated user.
- Id string
- Id of idp.
- Name string
- Name of the idp.
- string
- The method of making an authorization request.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- Client
Id string - Unique identifier issued by AS for the Okta IdP instance.
- Client
Secret string - Client secret issued by AS for the Okta IdP instance.
- Issuer
Mode string - Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
- Issuer
Url string - URI that identifies the issuer.
- Jwks
Binding string - The method of making a request for the OIDC JWKS.
- Jwks
Url string - Endpoint where the keys signer publishes its keys in a JWK Set.
- Max
Clock intSkew - Maximum allowable clock-skew when processing messages from the IdP.
- Protocol
Type string - The type of protocol to use.
- Scopes []string
- The scopes of the IdP.
- Token
Binding string - The method of making a token request.
- Token
Url string - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- Type string
- Type of idp.
- User
Info stringBinding - The method of making a user info request.
- User
Info stringUrl - Protected resource endpoint that returns claims about the authenticated user.
- Id string
- Id of idp.
- Name string
- Name of the idp.
- String
- The method of making an authorization request.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client
Id String - Unique identifier issued by AS for the Okta IdP instance.
- client
Secret String - Client secret issued by AS for the Okta IdP instance.
- issuer
Mode String - Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
- issuer
Url String - URI that identifies the issuer.
- jwks
Binding String - The method of making a request for the OIDC JWKS.
- jwks
Url String - Endpoint where the keys signer publishes its keys in a JWK Set.
- max
Clock IntegerSkew - Maximum allowable clock-skew when processing messages from the IdP.
- protocol
Type String - The type of protocol to use.
- scopes List<String>
- The scopes of the IdP.
- token
Binding String - The method of making a token request.
- token
Url String - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type String
- Type of idp.
- user
Info StringBinding - The method of making a user info request.
- user
Info StringUrl - Protected resource endpoint that returns claims about the authenticated user.
- id String
- Id of idp.
- name String
- Name of the idp.
- string
- The method of making an authorization request.
- string
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client
Id string - Unique identifier issued by AS for the Okta IdP instance.
- client
Secret string - Client secret issued by AS for the Okta IdP instance.
- issuer
Mode string - Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
- issuer
Url string - URI that identifies the issuer.
- jwks
Binding string - The method of making a request for the OIDC JWKS.
- jwks
Url string - Endpoint where the keys signer publishes its keys in a JWK Set.
- max
Clock numberSkew - Maximum allowable clock-skew when processing messages from the IdP.
- protocol
Type string - The type of protocol to use.
- scopes string[]
- The scopes of the IdP.
- token
Binding string - The method of making a token request.
- token
Url string - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type string
- Type of idp.
- user
Info stringBinding - The method of making a user info request.
- user
Info stringUrl - Protected resource endpoint that returns claims about the authenticated user.
- id string
- Id of idp.
- name string
- Name of the idp.
- str
- The method of making an authorization request.
- 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_ intskew - 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_ strbinding - The method of making a user info request.
- user_
info_ strurl - Protected resource endpoint that returns claims about the authenticated user.
- id str
- Id of idp.
- name str
- Name of the idp.
- String
- The method of making an authorization request.
- String
- IdP Authorization Server (AS) endpoint to request consent from the user and obtain an authorization code grant.
- client
Id String - Unique identifier issued by AS for the Okta IdP instance.
- client
Secret String - Client secret issued by AS for the Okta IdP instance.
- issuer
Mode String - Indicates whether Okta uses the original Okta org domain URL, a custom domain URL, or dynamic.
- issuer
Url String - URI that identifies the issuer.
- jwks
Binding String - The method of making a request for the OIDC JWKS.
- jwks
Url String - Endpoint where the keys signer publishes its keys in a JWK Set.
- max
Clock NumberSkew - Maximum allowable clock-skew when processing messages from the IdP.
- protocol
Type String - The type of protocol to use.
- scopes List<String>
- The scopes of the IdP.
- token
Binding String - The method of making a token request.
- token
Url String - IdP Authorization Server (AS) endpoint to exchange the authorization code grant for an access token.
- type String
- Type of idp.
- user
Info StringBinding - The method of making a user info request.
- user
Info StringUrl - 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.