OidcKey

Create a OidcKey Resource

new OidcKey(name: string, args?: OidcKeyArgs, opts?: CustomResourceOptions);

def OidcKey(resource_name, opts=None, algorithm=None, allowed_client_ids=None, name=None, rotation_period=None, verification_ttl=None, __props__=None);

func NewOidcKey(ctx *Context, name string, args *OidcKeyArgs, opts ...ResourceOption) (*OidcKey, error)

public OidcKey(string name, OidcKeyArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args OidcKeyArgs: 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 OidcKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

OidcKey Resource Properties

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

Inputs

The OidcKey resource accepts the following input properties:

Algorithm string: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
AllowedClientIds List<string>: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
Name string: Name of the OIDC Key to create.
RotationPeriod int: How often to generate a new signing key in number of seconds
VerificationTtl int: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

Algorithm string: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
AllowedClientIds []string: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
Name string: Name of the OIDC Key to create.
RotationPeriod int: How often to generate a new signing key in number of seconds
VerificationTtl int: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

algorithm string: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
allowedClientIds string[]: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
name string: Name of the OIDC Key to create.
rotationPeriod number: How often to generate a new signing key in number of seconds
verificationTtl number: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

algorithm str: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
allowed_client_ids List[str]: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
name str: Name of the OIDC Key to create.
rotation_period float: How often to generate a new signing key in number of seconds
verification_ttl float: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing OidcKey Resource

Get an existing OidcKey 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?: OidcKeyState, opts?: CustomResourceOptions): OidcKey

static get(resource_name, id, opts=None, algorithm=None, allowed_client_ids=None, name=None, rotation_period=None, verification_ttl=None, __props__=None);

func GetOidcKey(ctx *Context, name string, id IDInput, state *OidcKeyState, opts ...ResourceOption) (*OidcKey, error)

public static OidcKey Get(string name, Input<string> id, OidcKeyState? 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:

Algorithm string: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
AllowedClientIds List<string>: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
Name string: Name of the OIDC Key to create.
RotationPeriod int: How often to generate a new signing key in number of seconds
VerificationTtl int: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

Algorithm string: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
AllowedClientIds []string: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
Name string: Name of the OIDC Key to create.
RotationPeriod int: How often to generate a new signing key in number of seconds
VerificationTtl int: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

algorithm string: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
allowedClientIds string[]: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
name string: Name of the OIDC Key to create.
rotationPeriod number: How often to generate a new signing key in number of seconds
verificationTtl number: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

algorithm str: Signing algorithm to use. Signing algorithm to use. Allowed values are: RS256 (default), RS384, RS512, ES256, ES384, ES512, EdDSA.
allowed_client_ids List[str]: Array of role client ids allowed to use this key for signing. If empty, no roles are allowed. If “*“, all roles are allowed.
name str: Name of the OIDC Key to create.
rotation_period float: How often to generate a new signing key in number of seconds
verification_ttl float: “Controls how long the public portion of a signing key will be available for verification after being rotated in seconds.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud