Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. idp
  5. SamlKey
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

okta.idp.SamlKey

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-okta

    Example Usage

    Create SamlKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SamlKey(name: string, args: SamlKeyArgs, opts?: CustomResourceOptions);
    @overload
def SamlKey(resource_name: str,
            args: SamlKeyArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def SamlKey(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            x5cs: Optional[Sequence[str]] = None)
    func NewSamlKey(ctx *Context, name string, args SamlKeyArgs, opts ...ResourceOption) (*SamlKey, error)
    public SamlKey(string name, SamlKeyArgs args, CustomResourceOptions? opts = null)
    public SamlKey(String name, SamlKeyArgs args)
public SamlKey(String name, SamlKeyArgs args, CustomResourceOptions options)

    type: okta:idp:SamlKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args SamlKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args SamlKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var samlKeyResource = new Okta.Idp.SamlKey("samlKeyResource", new()
{
    X5cs = new[]
    {
        "string",
    },
});

    example, err := idp.NewSamlKey(ctx, "samlKeyResource", &idp.SamlKeyArgs{
	X5cs: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var samlKeyResource = new SamlKey("samlKeyResource", SamlKeyArgs.builder()        
    .x5cs("string")
    .build());

    saml_key_resource = okta.idp.SamlKey("samlKeyResource", x5cs=["string"])

    const samlKeyResource = new okta.idp.SamlKey("samlKeyResource", {x5cs: ["string"]});

    type: okta:idp:SamlKey
properties:
    x5cs:
        - string

    SamlKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts 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 List<String>
    base64-encoded X.509 certificate chain with DER encoding.
    x5cs string[]
    base64-encoded X.509 certificate chain with DER encoding.
    x5cs Sequence[str]
    base64-encoded X.509 certificate chain with DER encoding.
    x5cs List<String>
    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 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.
    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.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        expires_at: Optional[str] = None,
        kid: Optional[str] = None,
        kty: Optional[str] = None,
        use: Optional[str] = None,
        x5cs: Optional[Sequence[str]] = None,
        x5t_s256: Optional[str] = None) -> SamlKey
    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)
    public static SamlKey get(String name, Output<String> id, SamlKeyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 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 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 Sequence[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.
    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.

    Import

    A SAML IdP Signing Key can be imported via the key id.

    $ pulumi import okta:idp/samlKey:SamlKey example &#60;key id&#62;

    To learn more about importing existing cloud resources, see Importing resources.

    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.8.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-okta