SamlKey

Creates a SAML Identity Provider Signing Key.

This resource allows you to create and configure a SAML Identity Provider Signing Key.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Idp.SamlKey("example", new Okta.Idp.SamlKeyArgs
        {
            X5cs = 
            {
                okta_app_saml.Example.Certificate,
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.idp.SamlKey("example", x5cs=[okta_app_saml["example"]["certificate"]])

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

const example = new okta.idp.SamlKey("example", {
    x5cs: [okta_app_saml_example.certificate],
});

Create a SamlKey Resource

new SamlKey(name: string, args: SamlKeyArgs, opts?: CustomResourceOptions);

def SamlKey(resource_name, opts=None, x5cs=None, __props__=None);

func NewSamlKey(ctx *Context, name string, args SamlKeyArgs, opts ...ResourceOption) (*SamlKey, error)

public SamlKey(string name, SamlKeyArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args SamlKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SamlKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SamlKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

SamlKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The SamlKey resource accepts the following input properties:

X5cs List<string>: base64-encoded X.509 certificate chain with DER encoding.

X5cs []string: base64-encoded X.509 certificate chain with DER encoding.

x5cs string[]: base64-encoded X.509 certificate chain with DER encoding.

x5cs List[str]: base64-encoded X.509 certificate chain with DER encoding.

Outputs

All input properties are implicitly available as output properties. Additionally, the SamlKey resource produces the following output properties:

Created string: Date created.
ExpiresAt string: Date the cert expires.
Id string: The provider-assigned unique ID for this managed resource.
Kid string: Key ID.
Kty string: Identifies the cryptographic algorithm family used with the key.
Use string: Intended use of the public key.
X5tS256 string: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

Created string: Date created.
ExpiresAt string: Date the cert expires.
Id string: The provider-assigned unique ID for this managed resource.
Kid string: Key ID.
Kty string: Identifies the cryptographic algorithm family used with the key.
Use string: Intended use of the public key.
X5tS256 string: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

created string: Date created.
expiresAt string: Date the cert expires.
id string: The provider-assigned unique ID for this managed resource.
kid string: Key ID.
kty string: Identifies the cryptographic algorithm family used with the key.
use string: Intended use of the public key.
x5tS256 string: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

created str: Date created.
expires_at str: Date the cert expires.
id str: The provider-assigned unique ID for this managed resource.
kid str: Key ID.
kty str: Identifies the cryptographic algorithm family used with the key.
use str: Intended use of the public key.
x5t_s256 str: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

Look up an Existing SamlKey Resource

Get an existing SamlKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SamlKeyState, opts?: CustomResourceOptions): SamlKey

static get(resource_name, id, opts=None, created=None, expires_at=None, kid=None, kty=None, use=None, x5cs=None, x5t_s256=None, __props__=None);

func GetSamlKey(ctx *Context, name string, id IDInput, state *SamlKeyState, opts ...ResourceOption) (*SamlKey, error)

public static SamlKey Get(string name, Input<string> id, SamlKeyState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Created string: Date created.
ExpiresAt string: Date the cert expires.
Kid string: Key ID.
Kty string: Identifies the cryptographic algorithm family used with the key.
Use string: Intended use of the public key.
X5cs List<string>: base64-encoded X.509 certificate chain with DER encoding.
X5tS256 string: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

Created string: Date created.
ExpiresAt string: Date the cert expires.
Kid string: Key ID.
Kty string: Identifies the cryptographic algorithm family used with the key.
Use string: Intended use of the public key.
X5cs []string: base64-encoded X.509 certificate chain with DER encoding.
X5tS256 string: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

created string: Date created.
expiresAt string: Date the cert expires.
kid string: Key ID.
kty string: Identifies the cryptographic algorithm family used with the key.
use string: Intended use of the public key.
x5cs string[]: base64-encoded X.509 certificate chain with DER encoding.
x5tS256 string: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

created str: Date created.
expires_at str: Date the cert expires.
kid str: Key ID.
kty str: Identifies the cryptographic algorithm family used with the key.
use str: Intended use of the public key.
x5cs List[str]: base64-encoded X.509 certificate chain with DER encoding.
x5t_s256 str: base64url-encoded SHA-256 thumbprint of the DER encoding of an X.509 certificate.

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud